FatcaCrsSelfCertificationCreatedOrUpdated

webhook

fatcaCrsSelfCertificationCreatedOrUpdated

Callback received when a self-certification's information changes via the FATCA-CRS process.

Payload

JSON Body

type

string

enum

required

Callback type.

Show Details

FatcaCrsSelfCertificationCreatedOrUpdated

Callback received when a self-certification's information changes via the FATCA-CRS process.

Allowed:

appUserId

string

required

User identifier on partner side.

selfCertificationId

string

required

Self-certification identifier.

status

string

enum

required

Indicates the self-certification status.

Show Details

AwaitingAttachmentUpload	At least one attachment is required to proceed with the declaration.
UnderAttachmentReview	All required attachments have been sent and are under analysis.
UnderPdfGeneration	Self-certification PDF generation is in progress.
AwaitingDownload	Self-certification is ready for download and verification.
AwaitingSignature	Self-certification is ready for customer signature.
Aborted	Customer aborted this self-certification by starting a new one.
Rejected	Customer rejected the self-certification.
UnderSignedPdfGeneration	Signed PDF generation is in progress.
Validated	Self-certification was validated and signed.
Revoked	Customer revoked the valid self-certification.
Expired	Self-certification expired and must be replaced.

isUsPerson

boolean

Indicates whether the user is a US citizen or resident, or a partnership, corporation, company, or association created or organized in the US or under its laws.

isCurrent

boolean

Indicates the last valid self-certification.

signatureDate

date-time

Date of self-certification signature.

expirationDate

date-time

Expiration date of the self-certification, usually linked to the W8-Ben document, valid for three years.

lastUpdate

date-time

Date of the self-certification status last update.

taxInformation

array of objects

Countries where the user declares taxes and the corresponding tax identification number.

taxInformation

requiredAttachments

array of strings

Indicates the documents users must provide to prove their tax country declaration.

requiredAttachments

Allowed:

Headers

Webhook-Id

uuid

required

UUID of the sent callback

Webhook-Processdate

date-time

required

Callback send date

Responses

202

Webhook received successfully.

204

Webhook received but consumer no longer interested.

410

Webhook endpoint is gone; subscription disabled.

Loading…