API Reference

Update ITIN

post
https://example.com/programs//accounts//users//identity

Structure of API Call: POST /accounts/{accountIdentifier}/users/{userIdentifier}/identity

This endpoint allows an Individual Taxpayer Identification Number (ITIN) to be added to a customer’s account that originally enrolled using a Mexican Matricula ID only. This is primarily for U.S. tax purposes.

ITIN Limits:

  • Up to 1 active account with the same ITIN per consumer program is allowed
  • Up to 3 lifetime accounts with the same ITIN per consumer program are allowed
Path Params
string
required

Unique account identifier (UID or GUID).

string
required

Unique user identifier (UID or GUID).

string
required

Partner program code for the account.

Body Params

Encrypted request to update ITIN. See Gd.Bos.DataTransfer.Request.UpdateItinResquestEncrypted for required fields.

encryptedIdNumber
object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

string | null

The unique identifier (UID or GUID) of the account for which the ITIN is being updated.

string | null

The unique identifier (UID or GUID) of the user whose ITIN is being updated.

Headers
string
required

Unique request tracking identifier (X-GD-RequestId header).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago