API Reference

Add Document Information

post
https://platform-api.sandbox.testessential.net/card-holder/v4/card-requests/cp2//document-info

This endpoint is used to add identity document information for a CP2 card request, identified by the cardRequestId path parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

the unique identifier of the card request.

Body Params
string
required

country of citizenship in ISO-2 format.

string
enum
required

type of ID document.

Allowed:
date
required

expiry date in YYYY-MM-DD format. Example: 2018-05-10.

string
enum
required

cardholder's gender. Use 'M' for male or 'F' for female.

Allowed:
date
required

issue date in YYYY-MM-DD format. Example: 2018-05-10.

string
required

country that issued the ID document in ISO-2 format.

string
required
length ≥ 1

national identification number from the ID document.

string

Social Security Number (SSN). Required only when citizenship is USA.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

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

Updated about 1 month ago