Skip to main content
POST
Verify a CID set against BACEN

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Required key used to prevent replaying the mutation.

X-ISPB
string
required

ISPB of the participant the call acts for. It must be this deployment's direct participant or an indirect it sponsors; the body never carries it.

Pattern: ^[0-9A-Z]{8}$
Example:

"12345678"

Body

application/json
keyType
enum<string>
required

Key type whose CID set is verified.

Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
Example:

"CPF"

participantSyncVerifier
string
required

The participant's own sync verifier: the XOR of every active CID of this key type, 64 hex characters.

Pattern: ^[0-9a-fA-F]{64}$
Example:

"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

Response

Created

id
string
required

BACEN's own id for this sync verification.

Example:

"4521"

keyType
string
required

Key type that was verified.

Example:

"CPF"

participant
string
required

ISPB the verification was run for, resolved from X-ISPB.

Example:

"12345678"

participantSyncVerifier
string
required

The sync verifier that was sent to BACEN.

Example:

"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

result
string
required

BACEN's verdict, verbatim: OK when the CID sets match, NOK when they diverge.

Example:

"NOK"

bacen
object

BACEN's operational envelope for this call; omitted when BACEN sent no correlation id.