Skip to main content

Check parties related to an account

Request

ENDPOINT
/account/ACCOUNT_KEY/related_parties
METHOD
GET

PATH PARAMS

FieldTypeDescription
ACCOUNT_KEYuuidv4Unique identification key of the account

Response

STATUS
200
Response Body
{
"allowed_users": [
{
"natural_person_document_number": "49875468975",
"natural_person_key": "69850ae3-28bc-4779-a871-e73e1e993412",
"natural_person_name": "Gabriel Pomodoro",
"professional_data_key": "3532ea7d-855b-4033-8e1c-7a28d4440d4a"
},
{
"natural_person_document_number": "79857848695",
"natural_person_key": "7f775i35-da9b-493b-8d43-c5c34282f6cb",
"natural_person_name": "Fernando Teixeira",
"professional_data_key": "fd6b4ta8-0c1a-481f-a046-6e0e6edcfb43"
}
],
"legal_person_key": "40e841e1-edc6-44f2-9a55-7f97eed1bef5",
"owner_document_number": "10479846950100",
"owner_name": "EMPRESA DE TESTE S.A"
}

Body params

FieldTypeDescription
allowed_userslistObject containing the users linked to the account. (Object allowed_users)
legal_person_keyuuidv4Unique identification key of the account holder
owner_document_numberstringCNPJ number of the account holder.
owner_namestringCorporate Name of the Account Holder.

Object allowed_users

FieldTypeDescription
natural_person_document_numberstringCPF number of the user linked to the account.
natural_person_keyuuidv4Unique identification key of the user linked to the account.
natural_person_namestringName of the user linked to the account.
professional_data_keyuuidv4Unique identification key of the link between the user and the legal entity account holder.