Skip to navigation
API Internet BankingPeople

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.
X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

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