Create person representation
Use case
In this example, we will show how to set up person representation. We will set a private person Trevor Tuum as a representative of the legal person, New company Ltd.
The personId of the New company Ltd is ID-3394.
...persons/ID-3394/relations
The identification number of the private person Trevor Tuum is DQ654327C.
"idNumber": "DQ654327C"The private person is registered in the Great Britain.
"idCountryCode": "GB"The private person is the representative of the New company Ltd.
"relationTypeCode": "REPRESENTATIVE"The representation is in active status.
"statusCode": "ACTIVE"The private person is the beneficiary owner of the company. Note: If the private person is not a benificiary owner of the company, set to false.
"beneficiary": trueThe representation validity period. The date format: YYYY-MM-DD.
"representingRange": {
"startDate": "2023-06-06",
"endDate": "2023-06-13"
}Sample API call
To set the representation rights, call the following endpoint.
https://person-api.sandbox.tuumplatform.com/api/v1/persons/{personId}/relations
Sample request
Below is an example request body of the API call for creating person representation.
{
"relationships": [
{
"idNumber": "DQ654327C",
"idCountryCode": "GB",
"relationTypeCode": "REPRESENTATIVE",
"statusCode": "ACTIVE",
"beneficiary": true,
"representingRange": {
"startDate": "2023-06-06",
"endDate": "2023-06-13"
}
}
]
}curl 'https://person-api.sandbox.tuumplatform.com/api/v1/persons/ID-3394/relations' \
-H 'x-channel-code: SYSTEM' \
-H 'x-auth-token:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMTNUMjM6MDc6NDAiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODY2OTc2NjB9.Tt708jxWsjUQPurWItoY9QVqa2tb5PbnFBV-8voVRxY' \
-H 'Content-Type: application/json' \
-d '{
"relationships": [
{
"idNumber": "DQ654327C",
"idCountryCode": "GB",
"relationTypeCode": "REPRESENTATIVE",
"statusCode": "ACTIVE",
"beneficiary": true,
"representingRange": {
"startDate": "2023-06-06",
"endDate": "2023-06-13"
}
}
]
}'
```Sample response
Below you will find an example response to the API call from above.
Result
A new person relationship is created:
"personRelationshipId": "ID-1003"The code ID-1003 is a unique identifier of the person relationship between a legal and a private person.
"parentPersonId": "ID-3394",
"personId": "ID-3392",
"relationTypeCode": "REPRESENTATIVE"A legal person (New company Ltd) was set as a parent person. And a private person (Trevor Tuum) was added as a company representative.
Last updated
Was this helpful?