Skip to main content

Query account request details

Endpoint to query the full details of an account opening request, including information about the proposal status, related parties, attached documents, events, and configurations.

Information

This endpoint only supports checking and escrow account types.

Request​

ENDPOINT
/v2/account_request/ACCOUNT_REQUEST_KEY/full
METHOD
GET

Path Params​

FieldTypeDescription
ACCOUNT_REQUEST_KEYUUIDUnique key of the account request to be queried

Response​

STATUS
200
Response Body
{
    "proposal_key": "3e4b8746-da58-4799-bcd0-063326428d3f",
    "contract_number": "123456",
    "requester_key": "47d08366-a8ec-414c-a0a5-a089fc8a4ee8",
    "requester_name": "Requester Name",
    "requester_document_number": "30987145223",
    "request_control_key": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "reserved_account_key": "b1690f7b-1e82-4f76-a8d3-c326a2b89b67",
    "created_account_key": "c2790f8c-2f93-5g87-b9e4-d437b3c90c78",
    "reserved_related_account": {
        "reserved_account_key": "d3890g9d-3g04-6h98-c0f5-e548c4da1d89",
        "account_branch": "0001",
        "account_number": "5960388",
        "account_digit": "5",
        "document_number": "30987145223",
        "name": "Account Holder Name",
        "financial_institutions_code_number": "329",
        "financial_institutions": {
            "name": "QI Sociedade de Crédito Direto S.A.",
            "code_number": 329,
            "ispb": 32402502
        },
        "ted_account_type": {
            "enumerator": "checking_account",
            "translation_path": "...",
            "created_at": "2023-05-15T19:56:10"
        },
        "is_activated": true,
        "updated_at": "2023-05-15T19:56:10",
        "created_at": "2023-05-15T19:56:10"
    },
    "proposal_status": {
        "enumerator": "account_opened",
        "translation_path": "...",
        "created_at": "2023-05-15T19:56:10"
    },
    "account_type": {
        "enumerator": "checking",
        "translation_path": "...",
        "created_at": "2023-05-15T19:56:10"
    },
    "document_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "document_template_key": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "is_simplified": false,
    "created_at": "2023-05-15T19:56:10",
    "signed_contract": null,
    "additional_documents": null,
    "events": [
        {
            "old_status": {
                "enumerator": "pending",
                "translation_path": "...",
                "created_at": "2023-05-15T19:56:10"
            },
            "new_status": {
                "enumerator": "account_opened",
                "translation_path": "...",
                "created_at": "2023-05-15T19:56:10"
            },
            "rejection_reason": null,
            "event_description": "Account opened successfully",
            "created_at": "2023-05-15T20:00:00"
        }
    ],
    "destinations": [
        {
            "reserved_account_key": "e4901h0e-4h15-7i09-d1g6-f659d5eb2e90",
            "account_branch": "0001",
            "account_number": "5960389",
            "account_digit": "7",
            "document_number": "30987145223",
            "name": "Destination Name",
            "financial_institutions_code_number": "329",
            "financial_institutions": {
                "name": "QI Sociedade de Crédito Direto S.A.",
                "code_number": 329,
                "ispb": 32402502
            },
            "ted_account_type": {
                "enumerator": "checking_account",
                "translation_path": "...",
                "created_at": "2023-05-15T19:56:10"
            },
            "is_activated": true,
            "updated_at": "2023-05-15T19:56:10",
            "created_at": "2023-05-15T19:56:10"
        }
    ],
    "attached_documents": [
        {
            "document_key": "c3d4e5f6-a7b8-9012-cdef-123456789012",
            "document_type": {
                "enumerator": "identity",
                "translation_path": "...",
                "created_at": "2023-05-15T19:56:10"
            },
            "description": "Identity document",
            "document_url": "https://example.com/document.pdf",
            "is_activated": true,
            "updated_at": "2023-05-15T19:56:10",
            "created_at": "2023-05-15T19:56:10"
        }
    ],
    "related_parties": [
        {
            "person_key": "47d08366-a8ec-414c-a0a5-a089fc8a4ee8",
            "person_type": {
                "enumerator": "natural",
                "translation_path": "...",
                "created_at": "2023-05-15T19:56:10"
            },
            "individual_document_number": "30987145223",
            "company_document_number": null,
            "name": "Maria Luiza Vieira",
            "mother_name": "Dona Maria Mariane",
            "is_pep": false,
            "final_beneficiary": true,
            "is_signer": true,
            "is_activated": true,
            "address": {
                "street": "Av. Brigadeiro Faria Lima",
                "neighborhood": "Jardim Paulistano",
                "number": "2391",
                "postal_code": "01452905",
                "city": "São Paulo",
                "state": "SP",
                "country": "BR",
                "complement": "Complement",
                "created_at": "2023-05-15T19:56:10"
            },
            "phone": {
                "phone_type": {
                    "enumerator": "mobile",
                    "translation_path": "...",
                    "created_at": "2023-05-15T19:56:10"
                },
                "country_code": "055",
                "area_code": "11",
                "number": "999999999",
                "created_at": "2023-05-15T19:56:10"
            },
            "nationality": "Brazilian",
            "email": "teste@gmail.com",
            "birth_date": "1990-05-06",
            "role_type": {
                "enumerator": "account_holder",
                "translation_path": "...",
                "created_at": "2023-05-15T19:56:10"
            },
            "updated_at": "2023-05-15T19:56:10",
            "created_at": "2023-05-15T19:56:10"
        }
    ],
    "credit_operations": [],
    "automatic_transfer_config": {},
    "billing_configuration_data": null,
    "account_owner_data": null
}

Response Body Params​

FieldTypeDescription
proposal_keystringUnique key of the account request
contract_numberstringContract number
requester_keystringRequester key
requester_namestringRequester name
requester_document_numberstringRequester CPF or CNPJ
request_control_keystringRequest control key
reserved_account_keystringReserved account key
created_account_keystringCreated account key
reserved_related_accountobjectReserved related account data (can be null)
proposal_statusobjectCurrent proposal status
account_typeobjectAccount type
document_keystringDocument key
document_template_keystringDocument template key
is_simplifiedbooleanIndicates if it is a simplified account
created_atdatetimeRequest creation date
signed_contractobjectSigned contract data (can be null)
additional_documentsarrayAdditional documents (can be null)
eventsarrayList of request events
rejection_reasonstringRejection reason, present only if there is a rejection
destinationsarrayList of configured destinations
attached_documentsarrayList of attached documents
related_partiesarrayList of related parties
credit_operationsarrayList of credit operations
automatic_transfer_configobjectAutomatic transfer configuration
billing_configuration_dataobjectBilling configuration (can be null)
account_owner_dataobjectAccount owner data (can be null)

Object proposal_status / account_type​

FieldTypeDescription
enumeratorstringEnumerator value
translation_pathstringTranslation path
created_atdatetimeCreation date

Enumerators proposal_status​

EnumeratorDescription
pendingPending
pending_kyc_analysisPending KYC analysis
account_openedAccount opened
rejectedRejected
cancelledCancelled

Enumerators account_type​

EnumeratorDescription
checkingChecking account
escrowEscrow account

Object events​

FieldTypeDescription
old_statusobjectPrevious status (same format as proposal_status)
new_statusobjectNew status (same format as proposal_status)
rejection_reasonstringRejection reason (can be null)
event_descriptionstringEvent description
created_atdatetimeEvent date

Object destinations / reserved_related_account​

FieldTypeDescription
reserved_account_keystringReserved account key
account_branchstringBranch
account_numberstringAccount number
account_digitstringCheck digit
document_numberstringCPF or CNPJ
namestringAccount holder name
financial_institutions_code_numberstringFinancial institution code
financial_institutionsobjectFinancial institution data
ted_account_typeobjectTED account type
is_activatedbooleanWhether the destination is active
updated_atdatetimeUpdate date
created_atdatetimeCreation date

Object attached_documents​

FieldTypeDescription
document_keystringUnique document key
document_typeobjectDocument type (enumerator format)
descriptionstringDocument description
document_urlstringDocument URL
is_activatedbooleanWhether the document is active
updated_atdatetimeUpdate date
created_atdatetimeCreation date
FieldTypeDescription
person_keystringUnique person key
person_typeobjectPerson type (enumerator format)
individual_document_numberstringCPF
company_document_numberstringCNPJ
namestringName
mother_namestringMother's name
is_pepbooleanWhether the person is politically exposed
final_beneficiarybooleanWhether the person is the final beneficiary
is_signerbooleanWhether the person is a signer
is_activatedbooleanWhether the party is active
addressobjectAddress
phoneobjectPhone
nationalitystringNationality
emailstringEmail
birth_datestringDate of birth
role_typeobjectRole type (enumerator format)
updated_atdatetimeUpdate date
created_atdatetimeCreation date

Errors​

STATUS
404
Response Body: Account request not found
{
    "title": "Proposal Not Found",
    "description": "Proposal not found.",
    "translation": "Proposta não encontrada.",
    "code": "ACR000003"
}
STATUS
400
Response Body: Unsupported account type
{
    "title": "Temporarily unavailable",
    "description": "Temporarily unavailable",
    "translation": "Temporariamente indisponível",
    "code": "ACR000068"
}
STATUS
403
Response Body: User does not have credentials
{
    "title": "Permission Validator Error",
    "description": "Selected agent do not own this item.",
    "translation": "O agente selecionado não é dono do item.",
    "code": "QIT000005"
}