Edit ID Number

Use PATCH on /editIdNumber to edit the user's ID Number. ID Number refers to the primary identification method utilized by your program. Common ID Numbers include:

  • Social Security Number (SSN)
  • Passport Number
  • Driver's License Number

To retrieve a full ID Number, use Retrieve ID Number

Path Params
string
required

Pass in the Spidr user ID

Body Params

PATCH /v1/user/:id/editIdNumber Request body

string
required

The value of the identifier specified in idType. This may be the SSN, ITIN, or another ID depending on your program settings.

string
enum
required

The type of identifier required to onboard users into your program. Examples include SSN and ITIN.

Allowed:
Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json