Skip to navigation
API BaaSPeople

Verify a person's transaction PIN

A wrong attempt counts towards the person’s lockout, shared by every account. This is not a free oracle. Requires scope pin.manage.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
X-Acting-DocumentstringRequired
CPF of the person, 11 digits.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Request

This endpoint expects an object.
pinstringRequired

Response

PIN is correct.
validbooleanOptional

Errors

403
Forbidden Error
423
Locked Error
429
Too Many Requests Error