Skip to navigation
API BaaSPeople

Read a person's PIN lockout state

One object for the CPF in X-Acting-Document. set is false when the person has no PIN. The document comes back masked. 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.

Response

Lockout state and the effective policy.
documentstringOptional
setbooleanOptional
failedAttemptsintegerOptional
lockedbooleanOptional
lockedUntildatetime or nullOptional
requiresResetbooleanOptional
setAtdatetimeOptional
updatedAtdatetimeOptional
policyobjectOptional

Effective PIN policy (length, lockout thresholds).

Errors

400
Bad Request Error