Pular para o conteúdo principal

Exclusão de vínculo

Request

Token Request

ENDPOINT
/baas/token_request
MÉTODO
POST
Request Body
{
"contact_type":"sms",
"professional_data_deletion":{
"natural_person": "1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9",
"legal_person": "b678ae5c-5797-4bd9-8a4c-9cbd1a0829a4"
},
"agent_document_number": "99988877765"
}


Token Validation

ENDPOINT
/baas/movement_validation
MÉTODO
POST
Request Body
{
"token": "746116",
"professional_data_deletion":{
"natural_person": "1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9",
"legal_person": "b678ae5c-5797-4bd9-8a4c-9cbd1a0829a4",
}
}

Body Params

CampoTipoDescriçãoCaracteres
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
professional_data_deletionObjectVínculo de pessoa física a pessoa jurídica a ser removidoObjeto professional_data_deletion
agent_document_numberstringCPF de um dos administradores da conta que receberá o SMS para validação Ex: "99977766654"11

Objeto professional_data_deletion

CampoTipoDescriçãoCaracteres
natural_person *stringChave de identificação da pessoa física. Formato uuid v4. Ex: 1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb936
legal_person *stringChave de identificação da pessoa jurídica. Formato uuid v4. Ex: 1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb936
Formas de contato implementadas

contact_type permitido para esta operação é sms.

Número a receber token

Uma das pessoas cadastradas como administrador de conta da pessoa jurídica a ser vinculada receberá o token.

Response

Token Request

STATUS
200
Response Body
{}
STATUS
400
Response 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
400
Response 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
200
Response Body
{
"hash": "b6e2643b15493d8f604a3083a20f2476",
"return_response": {
"deleted": "OK",
"legal_person": "b678ae5c-5797-4bd9-8a4c-9cbd1a0829a4",
"natural_person": "1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9"
},
"validation": true
}
STATUS
401
Response Body: Token enviado expirado
{
"title": "Unauthorized",
"description": "Expired token",
"translation": "Token Expirado",
"code": "ACC000134",
"additional_data": {}
}
STATUS
401
Response Body: Token enviado inválido
{
"title": "Unauthorized",
"description": "Invalid token",
"translation": "Token Inválido",
"code": "ACC000133",
"additional_data": {}
}