Person contact change

Request

Token Request

ENDPOINT

/baas/token_request

METHOD

POST

Request Body

{
  "contact_type": "email",
  "person_contact_update": {
    "person_key": "3ea7f034-f06b-4e28-ae19-7c23694f546b",
    "phone_number": {
      "country_code": "55",
      "area_code": "888",
      "number": "988887777"
    }
  },
  "agent_document_number": "99988877765"
}

Token Validation

ENDPOINT

/baas/movement_validation

METHOD

POST

Request Body

{
  "token": "123456",
  "person_contact_update": {
    "person_key": "3ea7f034-f06b-4e28-ae19-7c23694f546b",
    "phone_number": {
      "country_code": "55",
      "area_code": "888",
      "number": "988887777"
    }
  }
}

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_contact_update	Object	Contact update information	Object person_contact_update
agent_document_number	string	CPF of one of the account administrators who will receive the SMS for validation. E.g., "99977766654"	11

Object person_contact_update

Field	Type	Description	Characters
person_key *	string	Identification key of the individual. UUID v4 format. E.g., 1ed6dc4e-a0a8-42bb-8cc0-0bb3b0233fb9	36
phone_number	Object	Object containing information on the new phone number	Object phone_number
email	string	New email to be registered

Object phone_number

Field	Type	Description	Characters
country_code *	string	Country code	1-3
area_code *	string	Phone area code	1-3
number *	string	Phone number	10

Implemented contact methods

The contact_type allowed for this operation is sms and email.

Modification limitations

To change the phone number, the contact method must be email, and to change the email, the contact method must be sms.

Number to receive token

The individual whose registration is being altered 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": "8e11308086ea336edb113a6ff5746778",
  "return_response": {
    "email": "test.email@email.com",
    "person_key": "110b3ee3-cae2-44de-ba2c-494434d5cb18",
    "phone": [
      {
        "area_code": "11",
        "country_code": "55",
        "number": "988887777"
      }
    ]
  },
  "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": {}
}