Skip to main content

Linkage exclusion

Request​

Token Request​

ENDPOINT
/baas/token_request
METHOD
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
METHOD
POST
Request Body
{
	"token": "746116",
	"professional_data_deletion":{
		"natural_person": "1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9",
		"legal_person": "b678ae5c-5797-4bd9-8a4c-9cbd1a0829a4",
	}
}

Body Params​

FieldTypeDescriptionCharacters
contact_type *string(/baas/token_request) Chosen method for sending the token. For SMS deliveries, only Brazilian numbers (+55) will receive the message."sms"
token *string(/baas/token_validation) Six-digit (6) code sent to the operation approver. E.g., "123456"6
professional_data_deletionObjectLink between an individual and a legal entity to be removedObject professional_data_deletion
agent_document_numberstringCPF of one of the account administrators who will receive the SMS for validation. E.g., "99977766654"11

Object professional_data_deletion​

FieldTypeDescriptionCharacters
natural_person *stringIdentification key of the individual. UUID v4 format. E.g., 1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb936
legal_person *stringIdentification key of the legal entity. UUID v4 format. E.g., 1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb936
Implemented contact methods

The contact_type allowed for this operation is sms.

Number to receive token

One of the individuals registered as account administrator of the legal entity to be linked will receive the token.

Response​

Token Request​

STATUS
200
Response Body
{}
STATUS
400
Response Body: Contact type not implemented/expired
{
	"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: Contact does not exist/invalid
{
	"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: Expired token
{
	"title": "Unauthorized",
	"description": "Expired token",
	"translation": "Token Expirado",
	"code": "ACC000134",
	"additional_data": {}
}
STATUS
401
Response Body: Invalid token
{
	"title": "Unauthorized",
	"description": "Invalid token",
	"translation": "Token Inválido",
	"code": "ACC000133",
	"additional_data": {}
}