Inclusão de vínculo

Request

Token Request

ENDPOINT

/baas/token_request

MÉTODO

POST

Request Body

{
	"contact_type":"sms",
	"professional_data_creation":{
	"natural_person": "1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9",
	"legal_person": "b678ae5c-5797-4bd9-8a4c-9cbd1a0829a4",
	"natural_person_roles": [
		{
			"product_type":"account",
			"role_type": "viewer"
		}
	],
	"post_type":"analyst"
	},
	"agent_document_number": "99988877765"
}

Token Validation

ENDPOINT

/baas/movement_validation

MÉTODO

POST

Request Body

{
	"token": "746116",
	"professional_data_creation":{
	"natural_person": "1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9",
	"legal_person": "b678ae5c-5797-4bd9-8a4c-9cbd1a0829a4",
	"natural_person_roles": [
		{
			"product_type":"account",
			"role_type": "viewer"
		}
	],
	"post_type":"analyst"
	}
}

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
professional_data_creation	Object	Informações de vínculo de pessoa física a pessoa jurídica	Objeto professional_data_creation
agent_document_number	string	CPF de um dos administradores da conta que receberá o SMS para validação Ex: "99977766654"	11

Objeto professional_data_creation

Campo	Tipo	Descrição	Caracteres
natural_person *	string	Chave de identificação da pessoa física. Formato uuid v4. Ex: 1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9	36
legal_person *	string	Chave de identificação da pessoa jurídica. Formato uuid v4. Ex: 1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9	36
natural_person_roles *	array	Informações de permissionamento e produto.	Array de Objeto natural_person_roles
post_type *	string	Número da conta.	"ceo", "analyst", "partner", "director", "attorney", "signer"

Objeto natural_person_role

Campo	Tipo	Descrição	Caracteres
product_type *	string	Tipo de produto a ser dado permissionamento sobre.	"account", "escrow"
role_type *	string	Tipo de permissionamento a ser dado ao produto.	"administrator", "requester", "viewer"

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": "c5ad79fc14d8447ae272c671fe6dc27e",
	"return_response": {
		"admission_date": "2023-06-13",
		"created_at": "2023-06-13T17:26:57",
		"email": null,
		"final_beneficiary": null,
		"is_active": true,
		"legal_person_key": "b678ae5c-5797-4bd9-8a4c-9cbd1a0829a4",
		"natural_person_key": "1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9",
		"natural_person_roles": [
			{
				"created_at": "2023-06-13T17:26:57",
				"natural_person_roles_events": [],
				"product_type": {
					"created_at": "2022-04-08T14:51:34",
					"enumerator": "escrow"
				},
				"role_type": {
					"created_at": "2021-02-26T14:14:52",
					"enumerator": "viewer"
				},
				"updated_at": "2023-06-13T18:24:35"
			},
			{
				"created_at": "2023-06-13T17:26:57",
				"natural_person_roles_events": [],
				"product_type": {
					"created_at": "2021-02-26T14:16:35",
					"enumerator": "account"
				},
				"role_type": {
					"created_at": "2021-02-26T14:14:52",
					"enumerator": "viewer"
				},
				"updated_at": "2023-06-13T18:24:35"
			}
		],
		"phone": null,
		"post_type": {
			"created_at": "2019-02-15T18:28:12",
			"enumerator": "analyst",
			"translation_path": "onboarding.PostType.analyst"
		},
		"profession_data_key": "78c8b92f-4e44-4725-a5fd-aa1fca78366d",
		"updated_at": "2023-06-13T18:24:35"
	},
	"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": {}
}