Skip to content
/
Person tax identification...

Persons (1.0)

Download OpenAPI description
persons.json
persons.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/persons/

Persons

Operations

Person mobile numbers

Operations

Person tax identifications

Operations

Create a tax identification for a person

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).

Path
person_idstringrequired
Bodyapplication/json

The content of the request.

numberstring

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"
countrystring

The country that issued the customer's TIN. Use an ISO 3166 two-character code.

Example: "DE"
primaryboolean

Indicates whether the provided TIN is the customer's primary TIN (i.e., their primary tax residence).

Example: true
reason_no_tinstring

Specifies the reason why the customer has not yet provided their TIN.

Enum"NOT_ASSIGNED_BY_COUNTRY""NOT_ASSIGNED_YET""OTHER"
reason_descriptionstring

Additional clarification around why the customer has not yet provided their TIN.

application/json
{
  "number": "31659837651",
  "country": "DE",
  "primary": true
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the tax identification resource created for a customer.

Example: "cba4289c773b7450482ee88a6e5126e9ctin"
countrystring

The country in which the customer is taxable. Uses [ISO 3661 alpha-2 Codes].

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
numberstring

The tax identification number (TIN).

Example: "12345678901"
primaryboolean

Indicates whether this is the primary tax residency. In case of multiple tax residencies, the customer must have only one primary TIN.

Example: true
reason_no_tinstring

Provides a reason why the tax identification does not contain a TIN.

Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
reason_descriptionstring

Additional context around why there is no TIN. Only required if OTHER was the value for the reason_no_tin field.

valid_untilstring(date)

Date when the tax identification becomes invalid.

tax_id_typestring

The type of tax ID document. Only required for Spain.

Enum"NIE""NIF"
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"
}

Index tax identifications for a person

Request

Returns an array containing all of the given person's tax identifications.

Path
person_idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

Unique ID of the tax identification resource created for a customer.

Example: "cba4289c773b7450482ee88a6e5126e9ctin"
countrystring

The country in which the customer is taxable. Uses [ISO 3661 alpha-2 Codes].

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
numberstring

The tax identification number (TIN).

Example: "12345678901"
primaryboolean

Indicates whether this is the primary tax residency. In case of multiple tax residencies, the customer must have only one primary TIN.

Example: true
reason_no_tinstring

Provides a reason why the tax identification does not contain a TIN.

Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
reason_descriptionstring

Additional context around why there is no TIN. Only required if OTHER was the value for the reason_no_tin field.

valid_untilstring(date)

Date when the tax identification becomes invalid.

tax_id_typestring

The type of tax ID document. Only required for Spain.

Enum"NIE""NIF"
]
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"
  }
]

Retrieve a person's tax identification

Request

Returns the person tax identification specified in the request URL.

Path
person_idstringrequired
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the tax identification resource created for a customer.

Example: "cba4289c773b7450482ee88a6e5126e9ctin"
countrystring

The country in which the customer is taxable. Uses [ISO 3661 alpha-2 Codes].

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
numberstring

The tax identification number (TIN).

Example: "12345678901"
primaryboolean

Indicates whether this is the primary tax residency. In case of multiple tax residencies, the customer must have only one primary TIN.

Example: true
reason_no_tinstring

Provides a reason why the tax identification does not contain a TIN.

Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
reason_descriptionstring

Additional context around why there is no TIN. Only required if OTHER was the value for the reason_no_tin field.

valid_untilstring(date)

Date when the tax identification becomes invalid.

tax_id_typestring

The type of tax ID document. Only required for Spain.

Enum"NIE""NIF"
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"
}

Update a person's tax identification

Request

Modifies one or more properties of a person's tax identification.

Path
person_idstringrequired
idstringrequired
Bodyapplication/json

The content of the request.

numberstring

The person's tax identification number (TIN).

Example: "31659837651"
countrystring

The country that issued the customer's TIN. Use an ISO 3661 two-character code.

Example: "DE"
primaryboolean

Specifies whether this is the customer's primary TIN.

Example: true
reason_no_tinstring

Specifies the reason why the customer has not yet provided their TIN.

Enum"NOT_ASSIGNED_BY_COUNTRY""NOT_ASSIGNED_YET""OTHER"
reason_descriptionstring

Additional clarification around why the customer has not yet provided their TIN.

application/json
{
  "number": "31659837651",
  "country": "DE",
  "primary": true
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

Unique ID of the tax identification resource created for a customer.

Example: "cba4289c773b7450482ee88a6e5126e9ctin"
countrystring

The country in which the customer is taxable. Uses [ISO 3661 alpha-2 Codes].

Enum"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
numberstring

The tax identification number (TIN).

Example: "12345678901"
primaryboolean

Indicates whether this is the primary tax residency. In case of multiple tax residencies, the customer must have only one primary TIN.

Example: true
reason_no_tinstring

Provides a reason why the tax identification does not contain a TIN.

Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
reason_descriptionstring

Additional context around why there is no TIN. Only required if OTHER was the value for the reason_no_tin field.

valid_untilstring(date)

Date when the tax identification becomes invalid.

tax_id_typestring

The type of tax ID document. Only required for Spain.

Enum"NIE""NIF"
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"
}

Person documents

Operations

Person language settings

Operations

Authorized persons

Operations