Skip to content
Download OpenAPI description
Languages
Servers
Mock Server

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

Operations
Operations
Operations

Create business tax identification

Request

Creates a tax identification for the given business. Please note the following:

  • The first tax_identification to be submitted must be the primary tax identification. If you create another tax_identification for the business with the value of primary set to true, then it will overrule the previous tax identification (i.e., the primary property of the previous one will be set to false).
  • A business may only have one tax identification per country.

Path
business_idstringrequired
Bodyapplication/json

The content of the request.

numberstring

The business' tax identification number (TIN).

Example: "31659837651"
countrystring

The business' tax country.

Example: "DE"
primaryboolean

Indicates whether this is the business' primary TIN.

Example: true
reason_no_tinstring

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

Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
reason_descriptionstring

Additional context around why there is no TIN for the business.

valid_untilstring(date)

Date when the tax identification becomes invalid.

tax_id_typestring

The type of tax ID provided by the business.

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 business tax identifications

Request

Returns an array containing all tax identifications for a business.

Path
business_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" } ]

Request

Returns information about the business tax identification specified in the request URL.

Path
business_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 business tax identification

Request

Updates one or more properties on an existing business tax identification.

Path
business_idstringrequired
idstringrequired
Bodyapplication/json

The content of the request.

numberstring

The business' tax identification number (TIN).

Example: "31659837651"
countrystring

The business' tax country.

Example: "DE"
primaryboolean

Indicates whether this is the business' primary TIN.

Example: true
reason_no_tinstring

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

Enum"NOT_ASSIGNED_YET""NOT_ASSIGNED_BY_COUNTRY""OTHER"
reason_descriptionstring

Additional context around why there is no TIN for the business.

valid_untilstring(date)

Date when the tax identification becomes invalid.

tax_id_typestring

The type of tax ID provided by the business.

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" }
Operations
Operations
Operations
Operations