API BaaSSecurity

Set or change an operator's transaction PIN

The PIN belongs to the operator (actingDocument), not the account. Changing an existing PIN requires currentPin. Requires scope pin.manage. The PIN is stored as an argon2id hash and never appears in a response or a log.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

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

Request

This endpoint expects an object.
actingDocumentstringRequired
CPF of the operator this PIN belongs to.
pinstringRequired6-12 characters
6 to 12 digits. No repetition, sequence or birth date.
currentPinstringOptional
Required when replacing an existing PIN.

Response

PIN created or updated.
accountIdstringOptional
actingDocumentstringOptional
Masked.
statusenumOptional

Errors

403
Forbidden Error
422
Unprocessable Entity Error