The content of the request.
Persons (1.0)
Download OpenAPI description
Languages
Servers
Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/persons/
Request
Submits a tax identification for a person.
The first tax identification to be submitted for a person must be their primary tax identification. If you add another tax identification with the value of primary set to true, then the previous primary tax identification will become a secondary tax identification (i.e., its primary value will change to false).
You may only create one tax identification per country per customer.
Important: When creating a tax identification for a person, always collect the country value from the person separately from their residence country in your frontend. Do not default to the customer's physical residence (i.e., the country value of their person resource).
Tax Identification Number (TIN). Must be left empty if reason_no_tin is provided.
Note: The Solaris API automatically validates the format of the supplied TIN based on the requirements for the customer's country. If the TIN does not follow the proper format, the API will return a 400 error.
Example: "31659837651"
The country that issued the customer's TIN. Use an ISO 3166 two-character code.
Example: "DE"
Indicates whether the provided TIN is the customer's primary TIN (i.e., their primary tax residence).
Example: true
Specifies the reason why the customer has not yet provided their TIN.
Enum"NOT_ASSIGNED_BY_COUNTRY""NOT_ASSIGNED_YET""OTHER"
- Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/persons/v1/persons/{person_id}/tax_identifications
- Payload
- cURL
- Java
- Python
- Node.js
- Go
- Ruby
- PHP
application/json
{ "number": "31659837651", "country": "DE", "primary": true }
Successful result of the operation
Unique ID of the tax identification resource created for a customer.
Example: "cba4289c773b7450482ee88a6e5126e9ctin"
Indicates whether this is the primary tax residency. In case of multiple tax residencies, the customer must have only one primary TIN.
Example: true
Provides a reason why the tax identification does not contain a TIN.
Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
Additional context around why there is no TIN. Only required if OTHER was the value for the reason_no_tin field.
Response
application/json
{ "id": "cba4289c773b7450482ee88a6e5126e9ctin", "country": "AD", "number": "12345678901", "primary": true, "reason_no_tin": "NOT_ASSIGNED_YET", "reason_description": "string", "valid_until": "2019-08-24", "tax_id_type": "NIE" }
- Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/persons/v1/persons/{person_id}/tax_identifications
- Payload
- cURL
- Java
- Python
- Node.js
- Go
- Ruby
- PHP
No request payloadSuccessful result of the operation
Unique ID of the tax identification resource created for a customer.
Example: "cba4289c773b7450482ee88a6e5126e9ctin"
Indicates whether this is the primary tax residency. In case of multiple tax residencies, the customer must have only one primary TIN.
Example: true
Provides a reason why the tax identification does not contain a TIN.
Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
Additional context around why there is no TIN. Only required if OTHER was the value for the reason_no_tin field.
Response
application/json
[ { "id": "cba4289c773b7450482ee88a6e5126e9ctin", "country": "AD", "number": "12345678901", "primary": true, "reason_no_tin": "NOT_ASSIGNED_YET", "reason_description": "string", "valid_until": "2019-08-24", "tax_id_type": "NIE" } ]
- Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/persons/v1/persons/{person_id}/tax_identifications/{id}
- Payload
- cURL
- Java
- Python
- Node.js
- Go
- Ruby
- PHP
No request payloadSuccessful result of the operation
Unique ID of the tax identification resource created for a customer.
Example: "cba4289c773b7450482ee88a6e5126e9ctin"
Indicates whether this is the primary tax residency. In case of multiple tax residencies, the customer must have only one primary TIN.
Example: true
Provides a reason why the tax identification does not contain a TIN.
Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
Additional context around why there is no TIN. Only required if OTHER was the value for the reason_no_tin field.
Response
application/json
{ "id": "cba4289c773b7450482ee88a6e5126e9ctin", "country": "AD", "number": "12345678901", "primary": true, "reason_no_tin": "NOT_ASSIGNED_YET", "reason_description": "string", "valid_until": "2019-08-24", "tax_id_type": "NIE" }
Bodyapplication/json
The content of the request.
The country that issued the customer's TIN. Use an ISO 3661 two-character code.
Example: "DE"
Specifies the reason why the customer has not yet provided their TIN.
Enum"NOT_ASSIGNED_BY_COUNTRY""NOT_ASSIGNED_YET""OTHER"
- Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/persons/v1/persons/{person_id}/tax_identifications/{id}
- Payload
- cURL
- Java
- Python
- Node.js
- Go
- Ruby
- PHP
application/json
{ "number": "31659837651", "country": "DE", "primary": true }
Successful result of the operation
Unique ID of the tax identification resource created for a customer.
Example: "cba4289c773b7450482ee88a6e5126e9ctin"
Indicates whether this is the primary tax residency. In case of multiple tax residencies, the customer must have only one primary TIN.
Example: true
Provides a reason why the tax identification does not contain a TIN.
Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
Additional context around why there is no TIN. Only required if OTHER was the value for the reason_no_tin field.
Response
application/json
{ "id": "cba4289c773b7450482ee88a6e5126e9ctin", "country": "AD", "number": "12345678901", "primary": true, "reason_no_tin": "NOT_ASSIGNED_YET", "reason_description": "string", "valid_until": "2019-08-24", "tax_id_type": "NIE" }