Create or update FATCA-EAI information for a user

patch

https://sb-api.xpollens.com/api/v3.0/users/{appUserId}/fatca-eai

Description

Create or update FATCA-EAI information for a user.

To apply this patch, using the following strong authentication is mandatory : /api/sca/v3.0/users/{appUserId}/fatca-eai

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

appUserId

string

required

User identifier on partner side

Body Params

FATCA - EAI Information

isUSPerson

boolean

required

Indicates if user is US citizen or resident, or if is a partnership, corporation, company or association created/organized in US or under its laws

taxInformation

array of objects

required

Tax identification number (TIN) and their corresponding countries where user declares taxes

taxInformation*

Headers

CorrId

string

Defaults to 4ad9b36d-4fdc-4452-b694-ebfb609f9b6a

Correlation Id

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Code	Description
PARTNER_CODE_REQUIRED	Partner code is mandatory
APP_USER_ID_REQUIRED	User identifier is mandatory
IS_US_PERSON_IS_REQUIRED	It is mandatory to inform if the user is an US Person or not
INVALID_NUMBER_OF_COUNTRIES	At least, one tax country must be informed. User can inform up to three tax countries
COUNTRY_CODE_LENGTH_MUST_BE_TWO	Country code must be in ISO alpha-2 format
COUNTRY_CODE_MANDATORY	Country code is mandatory
INVALID_COUNTRY_CODE	Country code '[VALUE]' is an invalid ISO alpha-2
TIN_REQUIRED	Tax identification number (TIN) for the country '[VALUE]' is mandatory
INVALID_TIN	One of the provided tax identification number (TIN) has an invalid format
IS_US_PERSON_INCONSISTENT_COUNTRIES	If the field “isUSPerson” is ‘true’, one of the tax countries must be “US”. If “US” is one of the tax countries, the field “isUSPerson” must be ‘true’

404

This AppUserId does not exist or wasn’t found, or the API address is incorrect

500

Server error

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

201FATCA-EAI information successfully created or updated