Pular para o conteúdo principal

Abertura de conta escrow PF

Request​

ENDPOINT
/escrow
MÉTODO
POST
Request Body
{
  "account_owner": {
        "person_type": "natural",
        "name": "Patrícia Tereza Bernardes",
        "mother_name": "Maria Mariane",
        "birth_date": "1990-05-06",
        "nationality": "nationality",
        "is_pep": false,
        "individual_document_number": "34651104630",
        "document_identification": "3c24579b-9810-4fa6-9b08-fe67d237160a",
        "email": "api@qitech.com.br",
        "address": {
            "street": "Av. Brigadeiro Faria Lima",
            "state": "SP",
            "city": "São Paulo",
            "neighborhood": "Jardim Paulistano",
            "number": "2391",
            "postal_code": "01452905",
            "complement": "1o. Andar"
        },
        "phone": {
            "country_code": "055",
            "area_code": "11",
            "number": "999999999"
        },
        "proof_of_residence": "780456bd-1eec-4e5f-82c0-d8c3921497ea"
    },
  "destination_list": [
        {
            "account_branch": "0001",
            "account_digit": "4",
            "account_number": "15570",
            "document_number": "34651104630",
            "financial_institutions_code_number": "329",
            "name": "Patrícia Tereza Bernardes",
            "ted_account_type": "deposit_account"
        }
    ],
  "signed_contract": {
        "document_key": "4d7f4e29-4b58-4905-9a69-b1f9215263f5",
        "signatures": [
            {
                "authenticity": {
                    "timestamp": "1970-01-01T00:00:01.080100Z",
                    "facial_recognition_key": "79003de0-2590-455d-9b73-426b8ca284eb",
                    "lang": "-35.8916627",
                    "lat": "-7.2226067",
                    "ip_address": "177.51.1.000",
                    "session_id": "jdifj329842"
                },
                "signer": {
                    "name": "IVANILDO DE SENA LIMA",
                    "email": "teste@gmail.com",
                    "phone": {
                        "country_code": "055",
                        "area_code": "11",
                        "number": "999999999"
                    },
                    "document_number": "99999999999"
                },
                "authentication_type": "opt-in"
            }
        ]
    }
}

BODY PARAMS​

CampoTipoDescriçãoCaracteres
account_owner *objectObjeto Dono da contaObjeto account_owner
destination_listobjectlista de contas de destino, que são aquelas para onde é permitida a transferência de recursos.Objeto destination_list
signed_contract *objectObjeto contento as informações da assinatura do contrato.Objeto signed_contract

Objeto account_owner​

CampoTipoDescriçãoCaracteres
addressstringEndereço do cliente.Objeto adress
birth_date *stringData de nascimento da pessoa (formato "AAAA-MM-DD")
document_identification *stringDOCUMENT_KEY do PDF do documento de identificação da pessoa com foto (RG ou CNH) (enviado previamente)
email *stringEmail do cliente.
individual_document_numberstringCPF da pessoa (apenas números). Limitado a 11 caracteres.
is_pep *stringDeclaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep).
mother_name *stringNome da mãe do cliente em caso de PF.100
name *stringRazão social em caso de operações PJ ou Nome da pessoa em caso de operações PF.100
nationality *stringNacionalidade do cliente.50
person_type *stringIdentificador de que o objeto enviado é uma pessoa física ou jurídica.
phonestringObjeto com dados do telefoneObjeto phone
proof_of_residencestringDOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente).

Objeto address​

Este objeto, presente tanto no objeto PF quanto no objeto PJ, é um simples objeto para representar um endereço.

CampoDescriçãoExemploMáx. Caracteres
street *stringRua do endereço100
state *stringEstado do endereço (com dois caracteres maiúsculos)2
city *stringCidade do endereço100
neighborhood *stringBairro do endereço100
number *stringNúmero da rua10
postal_code *stringCEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números)8
complement *stringComplemento do endereço (texto livre)100

Objeto signed_contract​

CampoTipoDescriçãoCaracteres
document_key *uuidv4Chave única de identificação do documento do Termo de Abertura de Conta ou Contrato de Conta Escrow. (A DOCUMENT_KEY é retornada na resposta do endpoint de Upload de documentos)36
signatures *listDados de assinatura do documento enviado. Cada item da lista, corresponde a um assinante do documento.Objeto signatures

Objeto signatures​

CampoTipoDescriçãoCaracteres
authenticity *objectConjunto de dados que evidenciam a assinatura eletrônica realizada pelo assinante.Objeto authenticity
signer *objectObjeto contendo os dados de um dos assinantes do documento.Objeto signer
authentication_type *enumeratorTipo de assinatura. Sempre será "opt-in""opt-in"

Objeto authenticity​

CampoTipoDescriçãoCaracteres
timestamp *stringData e hora do momento da assinatura do documento.27
facial_recognition_keyuuidv4Chave única de identificação da foto da selfie do titular da conta. (A DOCUMENT_KEY é retornada na resposta do endpoint de Upload de documentos)36
langstringCoordenada de longitude da geolocalização do assinante capturada no momento da assinatura.-
latstringCoordenada de latitude da geolocalização do assinante capturada no momento da assinatura.-
ip_addressstringEndereço IP do dispositivo do assinante.-
session_idstringID da seção do assinante no momento da assinatura.-

Objeto signer​

CampoTipoDescriçãoCaracteres
name *stringNome do assinante.-
email *stringEmail do assinante.-
phone *objectObjeto com dados do telefone do assinanteObjeto phone
document_number *stringCPF do assinante.11

Objeto phone​

CampoDescriçãoExemploMáx. Caracteres
country_code *stringCódigo DDI do telefone (https://ddi.guiamais.com.br/)3
area_code *stringCódigo DDD do telefone (https://ddd.guiamais.com.br/)2
number *stringNúmero de telefone (apenas números)10

Objeto phone​

CampoDescriçãoExemploMáx. Caracteres
country_code *stringCódigo DDI do telefone (https://ddi.guiamais.com.br/)3
area_code *stringCódigo DDD do telefone (https://ddd.guiamais.com.br/)2
number *stringNúmero de telefone (apenas números)10

Objeto destination_list​

CampoDescriçãoExemploMáx. Caracteres
account_branch *stringCódigo DDI do telefone (https://ddi.guiamais.com.br/)3
account_digit *stringCódigo DDD do telefone (https://ddd.guiamais.com.br/)2
account_number *stringNúmero de telefone (apenas números)10
document_number *stringNúmero de telefone (apenas números)10
financial_institutions_code_number *stringCódigo COMPE da instituição financeira (https://www.bcb.gov.br/pom/spb/estatistica/port/ASTR003.pdf) (com 3 dígitos).3
name *stringNome da pessoa física ou razão social da pessoa jurídica.10
ted_account_type *enumTipo da conta de destino.Enumeradores

Enumeradores ted_account_type​

EnumeradorTradução
checking_accountconta corrente
deposit_accountconta depósito
guaranteed_accountconta de garantia
investment_accountconta de investimento
payment_accountconta de pagamento
saving_accountconta poupança

Response​

STATUS
200
Response Body
{
  "data": {
    "account_info": {
      "account_branch": "0001",
      "account_digit": "3",
      "account_number": "66777",
      "financial_institution_code": "329"
    },
    "account_manager": {
      "company_representatives": [
        {
          "document_number": "08141163701",
          "name": "Aurora Simone Catarina Nogueira"
        }
      ],
      "document_number": "09456933000162",
      "name": "Kaique e Giovanna Contábil ME"
    },
    "account_owner": {
      "company_representatives": [
        {
          "document_number": "38689533370",
          "name": "Priscila Rayssa Barros"
        },
        {
          "document_number": "85324558400",
          "name": "Caio Bruno Dias"
        }
      ],
      "document_number": "98916615000167",
      "name": "Alice e Isis Advocacia ME"
    },
    "allowed_transfer_account_list": [
      {
        "account_branch": "0001",
        "account_digit": "2",
        "account_number": "532312",
        "document_number": "49067117153",
        "financial_institution": {
          "code": 341,
          "ispb": 60701190,
          "name": "Itaú Unibanco  S.A."
        },
        "name": "Juan Anthony Farias"
      },
      {
        "account_branch": "0002",
        "account_digit": "9",
        "account_number": "537612",
        "document_number": "39063217000123",
        "financial_institution": {
          "code": 33,
          "ispb": 90400888,
          "name": "Banco Santander (Brasil) S. A."
        },
        "name": "Farias Advogados"
      }
    ],
    "allowed_user": {
      "document_number": "13708610440",
      "name": "Renato Noah Pinto"
    }
  },
  "event_datetime": "2019-11-07 18:15:07",
  "key": "61341599-790b-4236-b42f-060634eba88f",
  "status": "waiting_administrator_approval",
  "webhook_type": "escrow"
}
STATUS
400
Response Body
{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}