Pular para o conteúdo principal

Consultar detalhes de pedido de conta

Endpoint para consultar os detalhes completos de um pedido de abertura de conta, incluindo informações sobre o status da proposta, partes relacionadas, documentos anexados, eventos e configurações.

Informação

Este endpoint suporta apenas contas do tipo checking (conta corrente) e escrow.

Request​

ENDPOINT
/v2/account_request/ACCOUNT_REQUEST_KEY/full
MÉTODO
GET

Path Params​

CampoTipoDescrição
ACCOUNT_REQUEST_KEYUUIDChave única do pedido de conta a ser consultado

Response​

STATUS
200
Response Body
{
    "proposal_key": "3e4b8746-da58-4799-bcd0-063326428d3f",
    "contract_number": "123456",
    "requester_key": "47d08366-a8ec-414c-a0a5-a089fc8a4ee8",
    "requester_name": "Nome do Solicitante",
    "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": "Nome do Titular",
        "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": "Conta aberta com sucesso",
            "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": "Nome do Destino",
            "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": "Documento de identidade",
            "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": "Complemento",
                "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": "brasileira",
            "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​

CampoTipoDescrição
proposal_keystringChave única do pedido de conta
contract_numberstringNúmero do contrato
requester_keystringChave do solicitante
requester_namestringNome do solicitante
requester_document_numberstringCPF ou CNPJ do solicitante
request_control_keystringChave de controle da requisição
reserved_account_keystringChave da conta reservada
created_account_keystringChave da conta criada
reserved_related_accountobjectDados da conta relacionada reservada (pode ser null)
proposal_statusobjectStatus atual da proposta
account_typeobjectTipo da conta
document_keystringChave do documento
document_template_keystringChave do template do documento
is_simplifiedbooleanIndica se é uma conta simplificada
created_atdatetimeData de criação do pedido
signed_contractobjectDados do contrato assinado (pode ser null)
additional_documentsarrayDocumentos adicionais (pode ser null)
eventsarrayLista de eventos do pedido
rejection_reasonstringMotivo da rejeição, presente apenas se houver rejeição
destinationsarrayLista de destinos configurados
attached_documentsarrayLista de documentos anexados
related_partiesarrayLista de partes relacionadas
credit_operationsarrayLista de operações de crédito
automatic_transfer_configobjectConfiguração de transferência automática
billing_configuration_dataobjectConfiguração de cobrança (pode ser null)
account_owner_dataobjectDados do titular da conta (pode ser null)

Objeto proposal_status / account_type​

CampoTipoDescrição
enumeratorstringValor do enumerador
translation_pathstringCaminho de tradução
created_atdatetimeData de criação

Enumeradores proposal_status​

EnumeradorDescrição
pendingPendente
pending_kyc_analysisPendente de análise KYC
account_openedConta aberta
rejectedRejeitado
cancelledCancelado

Enumeradores account_type​

EnumeradorDescrição
checkingConta corrente
escrowConta escrow

Objeto events​

CampoTipoDescrição
old_statusobjectStatus anterior (mesmo formato de proposal_status)
new_statusobjectNovo status (mesmo formato de proposal_status)
rejection_reasonstringMotivo da rejeição (pode ser null)
event_descriptionstringDescrição do evento
created_atdatetimeData do evento

Objeto destinations / reserved_related_account​

CampoTipoDescrição
reserved_account_keystringChave da conta reservada
account_branchstringAgência
account_numberstringNúmero da conta
account_digitstringDígito verificador
document_numberstringCPF ou CNPJ
namestringNome do titular
financial_institutions_code_numberstringCódigo da instituição financeira
financial_institutionsobjectDados da instituição financeira
ted_account_typeobjectTipo da conta TED
is_activatedbooleanSe o destino está ativo
updated_atdatetimeData de atualização
created_atdatetimeData de criação

Objeto attached_documents​

CampoTipoDescrição
document_keystringChave única do documento
document_typeobjectTipo do documento (formato enumerador)
descriptionstringDescrição do documento
document_urlstringURL do documento
is_activatedbooleanSe o documento está ativo
updated_atdatetimeData de atualização
created_atdatetimeData de criação
CampoTipoDescrição
person_keystringChave única da pessoa
person_typeobjectTipo de pessoa (formato enumerador)
individual_document_numberstringCPF
company_document_numberstringCNPJ
namestringNome
mother_namestringNome da mãe
is_pepbooleanSe é pessoa politicamente exposta
final_beneficiarybooleanSe é beneficiário final
is_signerbooleanSe é signatário
is_activatedbooleanSe está ativo
addressobjectEndereço
phoneobjectTelefone
nationalitystringNacionalidade
emailstringEmail
birth_datestringData de nascimento
role_typeobjectTipo de papel (formato enumerador)
updated_atdatetimeData de atualização
created_atdatetimeData de criação

Erros​

STATUS
404
Response Body: Pedido de conta não encontrado
{
    "title": "Proposal Not Found",
    "description": "Proposal not found.",
    "translation": "Proposta não encontrada.",
    "code": "ACR000003"
}
STATUS
400
Response Body: Tipo de conta não suportado
{
    "title": "Temporarily unavailable",
    "description": "Temporarily unavailable",
    "translation": "Temporariamente indisponível",
    "code": "ACR000068"
}
STATUS
403
Response Body: Usuário não possui credenciais
{
    "title": "Permission Validator Error",
    "description": "Selected agent do not own this item.",
    "translation": "O agente selecionado não é dono do item.",
    "code": "QIT000005"
}