Criação de pessoa
Request
Token Request
ENDPOINT
/baas/token_requestMÉTODO
POSTRequest Body
{
"contact_type": "sms",
"person_creation": {
"person": {
"date_of_birth": "1987-01-11",
"spouse_name": "sample spouse name",
"birth_place": "sample birth place",
"phone_number": {
"country_code": "55",
"area_code": "888",
"number": "988887777"
},
"representative": null,
"father_name": "sample father name",
"address": {
"street": "Rua Sample Avenue",
"complement": "Apto 123",
"state": "MG",
"number": "1234",
"neighborhood": "Cabral",
"postal_code": "38300000",
"city": "Ituiutaba"
},
"nationality": "Brasil",
"document_identification_number": "sample identification number",
"mother_name": "Sample Mama",
"person_type": "natural",
"name": "Sample Name Natural",
"profession": "sample profession",
"gender": null,
"email": "sample@gmail.com",
"document_number": "68346734500",
"marital_status": null
}
},
"agent_document_number": "99988877765"
}
Token Validation
ENDPOINT
/baas/movement_validationMÉTODO
POSTRequest Body
{
"token": "076244",
"person_creation": {
"person": {
"date_of_birth": "1987-01-11",
"spouse_name": "sample spouse name",
"birth_place": "sample birth place",
"phone_number": {
"country_code": "55",
"area_code": "888",
"number": "988887777"
},
"representative": null,
"father_name": "sample father name",
"address": {
"street": "Rua Sample Avenue",
"complement": "Apto 123",
"state": "MG",
"number": "1234",
"neighborhood": "Cabral",
"postal_code": "38300000",
"city": "Ituiutaba"
},
"nationality": "Brasil",
"document_identification_number": "sample identification number",
"mother_name": "Sample Mama",
"person_type": "natural",
"name": "Sample Name Natural",
"profession": "sample profession",
"gender": null,
"email": "sample@gmail.com",
"document_number": "68346734500",
"marital_status": null
}
}
}
Body Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
contact_type * | string | (/baas/token_request) Forma de envio escolhida para o token. Para envios de sms, apenas números brasileiros (+55) receberão a mensagem. | "sms" |
token * | string | (/baas/token_validation) Código de seis (6) dígitos enviado ao aprovador da operação. Ex: "123456" | 6 |
person_creation | object | Contêm objeto com as informações da pessoa a ser cadastrada | Objeto person_creation |
agent_document_number | string | CPF de um dos administradores da conta que receberá o SMS para validação Ex: "99977766654" | 11 |
Objeto person_creation
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
person * | object | Informações da pessoa a ser cadastrada. | Objeto person |
Objeto person
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
address | object | Endereço da pessoa. | Objeto adress |
date_of_birth * | string | Data de nascimento da pessoa (formato "AAAA-MM-DD") | |
document_identification_number | string | Campo destinado ao envio do número de uma documentação adicional, como a CNH (limitado a 16 caracteres). | |
email * | string | Email da pessoa. | |
document_number * | string | CPF da pessoa (apenas números). Limitado a 11 caracteres. | |
is_pep * | string | Declaração se a pessoa é PEP (http://www.portaldatransparencia.gov.br/download-de-dados/pep). | |
mother_name * | string | Nome da mãe da pessoa em caso de PF. | 100 |
name * | string | Razão social em caso de operações PJ ou Nome da pessoa em caso de operações PF. | 100 |
nationality * | string | Nacionalidade da pessoa. | 50 |
birth_place * | string | Local de nascimento da pessoa. | 50 |
person_type * | string | Identificador de que o objeto enviado é uma pessoa física ou jurídica. | "natural", "legal" |
phone_number * | object | Objeto com dados do telefone | Objeto phone |
proof_of_residence | string | DOCUMENT_KEY do PDF do comprovante de endereço do endereço enviado (enviado previamente). | |
spouse_name | string | Nome do cônjuge | |
father_name | string | Nome do pai da pessoa em caso de PF. | |
profession | string | Profissão da pessoa em caso de PF. |
Objeto address
| Campo | Descrição | Exemplo | Máx. Caracteres |
|---|---|---|---|
street * | string | Rua do endereço | 100 |
state * | string | Estado do endereço (com dois caracteres maiúsculos) | 2 |
city * | string | Cidade do endereço | 100 |
neighborhood * | string | Bairro do endereço | 100 |
number * | string | Número da rua | 10 |
postal_code * | string | CEP do endereço (http://www.buscacep.correios.com.br/sistemas/buscacep/) (apenas números) | 8 |
complement * | string | Complemento do endereço (texto livre) | 100 |
Objeto phone
| Campo | Descrição | Exemplo | Máx. Caracteres |
|---|---|---|---|
country_code * | string | Código DDI do telefone (https://ddi.guiamais.com.br/) | 3 |
area_code * | string | Código DDD do telefone (https://ddd.guiamais.com.br/) | 2 |
number * | string | Número de telefone (apenas números) | 10 |
Formas de contato implementadas
contact_type permitido para esta operação é sms.
Número a receber token
A pessoa a ser cadastrada receberá o token.
Response
Token Request
STATUS
200Response Body
{}
STATUS
400Response Body: Tipo de contato não implementado expirado
{
"title": "Bad Request",
"description": "Contact type {contact_type} not allowed",
"translation": "Forma de contato por {contact_type} não permitida",
"code": "ACC000152",
"additional_data": {}
}
STATUS
400Response Body: Contato não existente inválido
{
"title": "Bad Request",
"description": "Contact does not exist",
"translation": "Contato nao existe",
"code": "ACC000135",
"additional_data": {}
}
Token Validation
STATUS
200Response Body
{
"hash": "bd707fdcb3f78abcab8b5c5b7459f9aa",
"return_response": {
"birth_place": "sample birth place",
"created_at": "2023-06-14T20:51:32",
"date_of_birth": "1987-01-11T00:00:00",
"document_identification_number": "sample",
"email": "sample@gmail.com",
"father_name": "sample father name",
"gender": null,
"is_pep": false,
"kc_key": "2eedef51-7638-4874-bb98-661080bdfbfd",
"marital_status": null,
"mother_name": "Sample Mama",
"nationality": "Brasil",
"natural_revenue_range": {
"average_amount": null,
"created_at": "2021-03-12T13:26:08",
"description": "Unavailable",
"description_ptbr": "Indisponível",
"enumerator": "0",
"more_than_amount": null,
"up_to_amount": null
},
"person": {
"address": {
"city": "Ituiutaba",
"complement": "Apto 123",
"created_at": "2023-06-14T20:51:32",
"neighborhood": "Cabral",
"number": "1234",
"postal_code": "38300000",
"state": "MG",
"street": "Rua Sample Avenue"
},
"category": null,
"category_nick": null,
"created_at": "2023-06-14T20:51:32",
"document_number": "68346734500",
"domain": {
"created_at": "2022-06-29T19:35:17",
"domain_key": "abc36183-9845-40b9-8a6d-3805b48057e1",
"domain_name": "QI SCD Domain",
"owner_person_key": "bf623fcf-6e03-42b7-8664-55141c8acddb"
},
"internal_contact": null,
"internal_contact_person_key": null,
"name": "Sample Name Natural",
"person_category": null,
"person_code": 1681,
"person_key": "2eedef51-7638-4874-bb98-661080bdfbfd",
"person_status": {
"created_at": "2019-02-15T18:28:09",
"enumerator": "pending",
"translation_path": "onboarding.PersonStatus.pending"
},
"person_type": {
"created_at": "2019-02-15T18:28:08",
"enumerator": "natural",
"translation_path": "onboarding.PersonType.natural"
},
"phone": [
{
"area_code": "888",
"country_code": "55",
"created_at": "2023-06-14T20:51:32",
"number": "988887777",
"phone_key": "9a39e3ce-e4fd-447a-9856-83df19989895",
"phone_type": null
}
],
"professional_data": [],
"qualifications": [],
"registration_date": "2023-06-14",
"risk": null,
"special_attention": false,
"terms_acknowledgement": false,
"valid_cip_beneficiary": false
},
"profession": "sample profession",
"revenue_amount": null,
"spouse_name": null
},
"validation": true
}
STATUS
401Response Body: Token enviado expirado
{
"title": "Unauthorized",
"description": "Expired token",
"translation": "Token Expirado",
"code": "ACC000134",
"additional_data": {}
}
STATUS
401Response Body: Token enviado inválido
{
"title": "Unauthorized",
"description": "Invalid token",
"translation": "Token Inválido",
"code": "ACC000133",
"additional_data": {}
}