Upvest API Documentation
Operating Model:
Upvest API Documentation
Operating Model:

Taxes

Download Spec

All taxes related paths.

Retrieve tax residencies

get /users/{user_id}/tax_residencies

Retrieve tax residencies

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

taxes:readtaxes:admin

All Scopes

  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:read · Read reports
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

signature-input

string

required

upvest-api-version

string

Default
"1"
Enum
  • 1

user_id

string

uuid

required

User unique identifier.

Responses

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/json

updated_at

string

date-time

required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

fatca_relevance

object (fatca_relevance)

required

status

boolean

required

The user's FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false.

confirmed_at

string

date-time

required

Timestamp at which the user confirmed their FATCA status. RFC 3339-5, ISO8601 UTC

tax_residency

One Of

required

Optional tax identifier for DE

object (Optional tax identifier for DE)

country

string

required

Country code. ISO 3166 alpha-2 Codes.

  • DE - Germany
Default
"DE"
Enum
  • DE

tax_identifier_number

One Of

required

Tax identifier number

null

null

string

Min Length
10
Max Length
50

With tax identifier number

object (With tax identifier number)

country

All Of

required

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

Must not match

Default
"DE"

tax_identifier_number

string

required

Tax identifier number

Max Length
50

Without tax identifier number

object (Without tax identifier number)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

reason_missing_tin

string

required

Reason why TIN is missing

  • NOT_YET_ASSIGNED - Indicates that the tax identification number has not yet been assigned by the tax authorities. A common example is, that a user has moved to a country and thus became taxable, but that the tax authorities have not yet assigned the TIN to this user.
  • COUNTRY_HAS_NO_TIN - Indicates that the specific country does not provide a TIN.
  • OTHER_REASONS - Applies in case of other reasons - i.e. when a user does not have the TIN at hand. Note this may cause additional inquiries by our customer service team.
Enum
  • NOT_YET_ASSIGNED
  • COUNTRY_HAS_NO_TIN
  • OTHER_REASONS

residencies_declared_at

string

datetime

required

The timestamp at which all tax residencies were declared.

additional_tax_residencies

array[One Of]

required

Tax residency

One Of

Optional tax identifier for DE

object (Optional tax identifier for DE)

country

string

required

Country code. ISO 3166 alpha-2 Codes.

  • DE - Germany
Default
"DE"
Enum
  • DE

tax_identifier_number

One Of

required

Tax identifier number

null

null

string

Min Length
10
Max Length
50

With tax identifier number

object (With tax identifier number)

country

All Of

required

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

Must not match

Default
"DE"

tax_identifier_number

string

required

Tax identifier number

Max Length
50

Without tax identifier number

object (Without tax identifier number)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

reason_missing_tin

string

required

Reason why TIN is missing

  • NOT_YET_ASSIGNED - Indicates that the tax identification number has not yet been assigned by the tax authorities. A common example is, that a user has moved to a country and thus became taxable, but that the tax authorities have not yet assigned the TIN to this user.
  • COUNTRY_HAS_NO_TIN - Indicates that the specific country does not provide a TIN.
  • OTHER_REASONS - Applies in case of other reasons - i.e. when a user does not have the TIN at hand. Note this may cause additional inquiries by our customer service team.
Enum
  • NOT_YET_ASSIGNED
  • COUNTRY_HAS_NO_TIN
  • OTHER_REASONS

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Examples

{
  "additional_tax_residencies": [
    {
      "country": "IT",
      "tax_identifier_number": "40021158793"
    },
    {
      "country": "FR",
      "reason_missing_tin": "COUNTRY_HAS_NO_TIN"
    }
  ],
  "fatca_relevance": {
    "confirmed_at": "2021-08-24T14:15:22Z",
    "status": false
  },
  "residencies_declared_at": "2021-09-24T12:56:22Z",
  "tax_residency": {
    "country": "DE",
    "tax_identifier_number": "12345678901"
  },
  "updated_at": "2021-07-21T14:10:00.00Z"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 405,
  "type": "method_not_allowed"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Update tax residencies

post /users/{user_id}/tax_residencies

Update tax residencies

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

taxes:admin

All Scopes

  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:read · Read reports
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

signature-input

string

required

upvest-api-version

string

Default
"1"
Enum
  • 1

idempotency-key

string

uuid

required

Example
"f1150421-2e34-42b6-aae9-52ef157065b9"

user_id

string

uuid

required

User unique identifier.

application/json

fatca_relevance

object (fatca_relevance)

required

status

boolean

required

The user's FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false.

confirmed_at

string

date-time

required

Timestamp at which the user confirmed their FATCA status. RFC 3339-5, ISO8601 UTC

tax_residency

One Of

required

Optional tax identifier for DE

object (Optional tax identifier for DE)

country

string

required

Country code. ISO 3166 alpha-2 Codes.

  • DE - Germany
Default
"DE"
Enum
  • DE

tax_identifier_number

One Of

Tax identifier number

null

null

string

Max Length
50

With tax identifier number

object (With tax identifier number)

country

All Of

required

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

Must not match

Default
"DE"

tax_identifier_number

string

required

Tax identifier number

Min Length
10
Max Length
50

Without tax identifier number

object (Without tax identifier number)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

reason_missing_tin

string

required

Reason why TIN is missing

  • NOT_YET_ASSIGNED - Indicates that the tax identification number has not yet been assigned by the tax authorities. A common example is, that a user has moved to a country and thus became taxable, but that the tax authorities have not yet assigned the TIN to this user.
  • COUNTRY_HAS_NO_TIN - Indicates that the specific country does not provide a TIN.
  • OTHER_REASONS - Applies in case of other reasons - i.e. when a user does not have the TIN at hand. Note this may cause additional inquiries by our customer service team.
Enum
  • NOT_YET_ASSIGNED
  • COUNTRY_HAS_NO_TIN
  • OTHER_REASONS

residencies_declared_at

string

datetime

required

The timestamp at which all tax residencies were declared.

additional_tax_residencies

One Of

null

null

array[One Of]

Tax residency

One Of

Optional tax identifier for DE

object (Optional tax identifier for DE)

country

string

required

Country code. ISO 3166 alpha-2 Codes.

  • DE - Germany
Default
"DE"
Enum
  • DE

tax_identifier_number

One Of

Tax identifier number

null

null

string

Max Length
50

With tax identifier number

object (With tax identifier number)

country

All Of

required

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

Must not match

Default
"DE"

tax_identifier_number

string

required

Tax identifier number

Min Length
10
Max Length
50

Without tax identifier number

object (Without tax identifier number)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

reason_missing_tin

string

required

Reason why TIN is missing

  • NOT_YET_ASSIGNED - Indicates that the tax identification number has not yet been assigned by the tax authorities. A common example is, that a user has moved to a country and thus became taxable, but that the tax authorities have not yet assigned the TIN to this user.
  • COUNTRY_HAS_NO_TIN - Indicates that the specific country does not provide a TIN.
  • OTHER_REASONS - Applies in case of other reasons - i.e. when a user does not have the TIN at hand. Note this may cause additional inquiries by our customer service team.
Enum
  • NOT_YET_ASSIGNED
  • COUNTRY_HAS_NO_TIN
  • OTHER_REASONS

Responses

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/json

updated_at

string

date-time

required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

fatca_relevance

object (fatca_relevance)

required

status

boolean

required

The user's FATCA status is true if the user is subject to paying taxes in the US, otherwise it can be set to false.

confirmed_at

string

date-time

required

Timestamp at which the user confirmed their FATCA status. RFC 3339-5, ISO8601 UTC

tax_residency

One Of

required

Optional tax identifier for DE

object (Optional tax identifier for DE)

country

string

required

Country code. ISO 3166 alpha-2 Codes.

  • DE - Germany
Default
"DE"
Enum
  • DE

tax_identifier_number

One Of

required

Tax identifier number

null

null

string

Min Length
10
Max Length
50

With tax identifier number

object (With tax identifier number)

country

All Of

required

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

Must not match

Default
"DE"

tax_identifier_number

string

required

Tax identifier number

Max Length
50

Without tax identifier number

object (Without tax identifier number)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

reason_missing_tin

string

required

Reason why TIN is missing

  • NOT_YET_ASSIGNED - Indicates that the tax identification number has not yet been assigned by the tax authorities. A common example is, that a user has moved to a country and thus became taxable, but that the tax authorities have not yet assigned the TIN to this user.
  • COUNTRY_HAS_NO_TIN - Indicates that the specific country does not provide a TIN.
  • OTHER_REASONS - Applies in case of other reasons - i.e. when a user does not have the TIN at hand. Note this may cause additional inquiries by our customer service team.
Enum
  • NOT_YET_ASSIGNED
  • COUNTRY_HAS_NO_TIN
  • OTHER_REASONS

residencies_declared_at

string

datetime

required

The timestamp at which all tax residencies were declared.

additional_tax_residencies

array[One Of]

required

Tax residency

One Of

Optional tax identifier for DE

object (Optional tax identifier for DE)

country

string

required

Country code. ISO 3166 alpha-2 Codes.

  • DE - Germany
Default
"DE"
Enum
  • DE

tax_identifier_number

One Of

required

Tax identifier number

null

null

string

Min Length
10
Max Length
50

With tax identifier number

object (With tax identifier number)

country

All Of

required

string

^[A-Z]{2}$

Country code. ISO 3166 alpha-2 Codes.

Must not match

Default
"DE"

tax_identifier_number

string

required

Tax identifier number

Max Length
50

Without tax identifier number

object (Without tax identifier number)

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

reason_missing_tin

string

required

Reason why TIN is missing

  • NOT_YET_ASSIGNED - Indicates that the tax identification number has not yet been assigned by the tax authorities. A common example is, that a user has moved to a country and thus became taxable, but that the tax authorities have not yet assigned the TIN to this user.
  • COUNTRY_HAS_NO_TIN - Indicates that the specific country does not provide a TIN.
  • OTHER_REASONS - Applies in case of other reasons - i.e. when a user does not have the TIN at hand. Note this may cause additional inquiries by our customer service team.
Enum
  • NOT_YET_ASSIGNED
  • COUNTRY_HAS_NO_TIN
  • OTHER_REASONS

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Request Examples

{
  "fatca_relevance": {
    "confirmed_at": "2021-08-24T14:15:22Z",
    "status": false
  },
  "residencies_declared_at": "2021-09-24T12:56:22Z",
  "tax_residency": {
    "country": "DE",
    "tax_identifier_number": "12345678901"
  }
}
{
  "additional_tax_residencies": [
    {
      "country": "IT",
      "tax_identifier_number": "40021158793"
    },
    {
      "country": "FR",
      "reason_missing_tin": "COUNTRY_HAS_NO_TIN"
    }
  ],
  "fatca_relevance": {
    "confirmed_at": "2021-08-24T14:15:22Z",
    "status": false
  },
  "residencies_declared_at": "2021-09-24T12:56:22Z",
  "tax_residency": {
    "country": "DE",
    "tax_identifier_number": "12345678901"
  }
}

Response Examples

{
  "additional_tax_residencies": [
    {
      "country": "AU",
      "reason_missing_tin": "NOT_YET_ASSIGNED"
    }
  ],
  "fatca_relevance": {
    "confirmed_at": "2021-08-24T14:15:22Z",
    "status": false
  },
  "residencies_declared_at": "2020-08-24",
  "tax_residency": {
    "country": "DE",
    "tax_identifier_number": "40021158793"
  },
  "updated_at": "2021-07-21T14:10:00.00Z"
}
{
  "status": 400,
  "type": "bad_request"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Was this page helpful?