Two-Factor Authentication

Token in Sandbox

To facilitate testing in the sandbox environment, the token will always have the value 329329. This behavior is exclusive to the sandbox environment.

Request

ENDPOINT

/baas/pix/key_claim_request/CLAIM_REQUEST_KEY/twofa_validation

METHOD

PATCH

Path params

Field	Type	Description
claim_request_key	string	The key of the portability request.

Request Body

{
  "verification_code": "432371"
}

Body Params

Field	Type	Description	Characters
verification_code	string	token received by email or cellphone number.	6

Response

STATUS

200

Response Body

{
  "max_conclusion_date": "2023-05-26T12:13:25",
  "claim_request_status": "pending",
  "claimant": {
    "document_number": "12345678000190",
    "claimant_key": "6aaadfbc-76ba-45d2-bb21-138bcb2baa62",
    "account_opened_at": "2023-01-17T12:28:37",
    "account_branch": "0001",
    "account_type": "escrow",
    "account_number": "7336349",
    "person_type": "legal",
    "account_digit": "0"
  },
  "max_resolution_date": "2023-05-19T12:13:25",
  "claimant_bank_name": "QI SCD S.A.",
  "pix_key": {
    "pix_key_type": "cnpj",
    "pix_key_status": "pending_confirmation",
    "created_at": "2023-05-12T12:13:24",
    "updated_at": "2023-05-12T12:13:24",
    "account_key": "169010e3-6c1e-4521-9253-11cbbf36c59j",
    "pix_key": "12345678000190"
  },
  "donator_ispb": null,
  "external_key": null,
  "claim_request_key": "7f8b67d2-d8e4-4759-85eb-e4d0ac24708c",
  "claim_request_type": "portability",
  "client_role": "claimant",
  "confirmation_reason": null,
  "requester_key": "e151044c-44d0-48b3-9df1-0b9475077fe5",
  "claimant_bank_code": "329",
  "cancelled_by": null,
  "request_failure_reason": null,
  "donator": null,
  "account_key": "169010e3-6c1e-4521-9253-11cbbf36c59j"
}

STATUS

4XX

Response Body: Error

{
  "title": "title",
  "description": "description in English",
  "translation": "description in Portuguese",
  "code": "code",
  "extra_fields": {}
}

HTTP Code	QI Code code	Title title	Description (eng) Description	Description (ptbr) translation
400	PIX000047	Claim request action not allowed on current status	Validate Claim request action only allowed for pending_validation requests.	Ação validate para claim request permitida somente para pedidos pending_validation.
401	2FA000401	Unauthorized	Invalid verification combination.	Código de verificação inválido.
403	2FA000403	Forbidden	Code already verified.	Este código já foi utilizado.
403	QIT000005	Permission Validator Error.	Selected agent do not own this item.	O agente selecionado não é dono do item.
410	2FA000410	Gone	Expired Code.	Código de verificação expirado.
404	PIX000031	Claim Request not found	Claim Request not found for key: 7f8b67d2-d8e4-4759-85eb-e4d0ac24708c.	Claim Request não encontrada para a chave: 7f8b67d2-d8e4-4759-85eb-e4d0ac24708c.