Create and update FATCA information for a Customer

patch

https://sb-api.xpollens.com/api/v2.1/user/{appUserId}/fatcaEai

Description

API to Create and update the Foreign Account Tax Compliance Act (FATCA) information for a Customer

Strong customer Authentication: Agent Partners have to use the following EndPoint :

PATCH /api/sca/v2.1/user/{appUserId}/fatcaEai to perform the customer Strong Authentication (mandatory)

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

Americanness

boolean

required

Determines whether the client is American or not

TaxInfo

array of objects

required

Array of objects: at least one element is required, at most three

TaxInfo*

Headers

CorrId

string

Defaults to e409401a-c31f-459c-910c-883c4dba3234

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

201

Created

Code	Description
PARTNER_CODE_REQUIRED	The partner code is required
APP_USER_ID_REQUIRED	The user identifier is required
AMERICANNESS_IS_REQUIRED	Americanness must be provided
INVALID_NUMBER_OF_COUNTRIES	Tax info must be provided for at least one country and at most three
COUNTRY_CODE_LENGTH_MUST_BE_TWO	A country code should contains exactly two letters
COUNTRY_CODE_MANDATORY	Country code is mandatory
INVALID_COUNTRY_CODE	Country code '[VALUE]' doesn't exist
TIN_REQUIRED	Tax identification number (TIN) required for country '[VALUE]'
INVALID_TIN	At least one the provided tax identification number is invalid
AMERICANNESS_INCONSISTENT_COUNTRIES	Americanness is true, so the United States should be defined as a tax country, or Americanness is false, so the United States should not be defined as a tax country

404

Not Found