Person creation

Request

Token Request

ENDPOINT

/baas/token_request

METHOD

POST

Request 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_validation

METHOD

POST

Request 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

Field	Type	Description	Characters
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
person_creation	object	Contains an object with the information of the person to be registered	Object person_creation
agent_document_number	string	CPF of one of the account administrators who will receive the SMS for validation. E.g., "99977766654"	11

Object person_creation

Field	Type	Description	Characters
person *	object	Information of the person to be registered.	Object person

Object person

Field	Type	Description	Characters
address	object	Person's address.	Object address
date_of_birth *	string	Date of birth of the person (format "YYYY-MM-DD")
document_identification_number *	string	DOCUMENT_KEY of the person's photo ID document (RG or CNH) (previously sent)
email *	string	Person's email.
document_number *	string	Person's CPF (numbers only). Limited to 11 characters.
is_pep *	string	Statement if the person is a PEP (Politically Exposed Person) (http://www.portaldatransparencia.gov.br/download-de-dados/pep).
mother_name *	string	Mother's name of the person in case of an Individual.	100
name *	string	Corporate name in case of legal operations or Person's name in case of individual operations.	100
nationality *	string	Person's nationality.	50
birth_place *	string	Place of birth of the person.	50
person_type *	string	Identifier indicating whether the sent object is an individual or a legal entity.	"natural", "legal"
phone_number *	object	Object with phone details	Object phone
proof_of_residence	string	DOCUMENT_KEY of the PDF of the submitted address proof (previously sent).
spouse_name	string	Spouse's name
father_name	string	Father's name of the person in case of an Individual.
profession	string	Person's profession in case of an Individual.

Object address

Field	Description	Example	Max. Characters
street *	string	Street address	100
state *	string	State address (with two uppercase characters)	2
city *	string	City address	100
neighborhood *	string	Neighborhood address	100
number *	string	Street number	10
postal_code *	string	ZIP code (http://www.buscacep.correios.com.br/sistemas/buscacep/) (numbers only)	8
complement *	string	Address complement (free text)	100

Object phone

Field	Description	Example	Max. Characters
country_code *	string	Phone country code (https://ddi.guiamais.com.br/)	3
area_code *	string	Phone area code (https://ddd.guiamais.com.br/)	2
number *	string	Phone number (numbers only)	10

Implemented contact methods

The contact_type allowed for this operation is sms.

Number to receive token

The person to be registered 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": "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

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": {}
}