API Reference

Add Document Information

post
https://platform-api.sandbox.testessential.net/card-holder/v3/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.

Path Params
uuid
required

the unique identifier of the card request.

Body Params
string
enum
required

type of ID document.

Allowed:
string
required

country of citizenship in ISO-2 format.

string
required
length ≥ 1

national identification number from the ID document.

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.

date
required

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 months ago

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