Confirm PIX key OTP

POST

https://tenant.api.corpx.com/v1/accounts/:accountId/pix/keys/verify

Second step of registering an email or phone PIX key. Send the challengeId returned by POST .../pix/keys (202 pending_verification) together with the 6-digit code the holder received. On success the key is registered at the partner and the response is the same 201 as a direct registration. Wrong code returns code_invalid; after too many attempts the challenge is locked (challenge_locked) and a new registration is required.

Second step of registering an `email` or `phone` PIX key. Send the `challengeId` returned by `POST .../pix/keys` (`202 pending_verification`) together with the 6-digit code the holder received. On success the key is registered at the partner and the response is the same `201` as a direct registration. Wrong code returns `code_invalid`; after too many attempts the challenge is locked (`challenge_locked`) and a new registration is required.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired

Account identifier.

Request

This endpoint expects an object.

challengeIdstringRequired

codestringRequired

6-digit OTP. Never logged.

Response

Pix key registered after OTP confirmation.

keyTypestring

keyTypeIdinteger

pixKeystring

createddatetime

Errors

400

Bad Request Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error