Create Cardholder

post

https://evolve-sbx.cardprogramservices.com/cardholders

Used for creating a new cardholder

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

first_name

string

required

length ≤ 50

First name of cardholder

middle_name

string

required

length ≤ 50

Middle name of cardholder

last_name

string

required

length ≤ 50

Last name of cardholder

gender

enum

required

Gender of cardholder

Allowed:

string

required

Email address of cardholder

primary_cardholder_id

string

Required if secondary card is to be created

phone_details

array of objects

required

length between 1 and 1

phone_details*

phone_type

enum

required

Type of phone provided

Allowed:

country_dialing_code

int32

required

ISO numeric dialing country code

phone_number

string

required

length ≤ 50

Phone number

date_of_birth

date

required

Date of birth of cardholder. Format YYYY-MM-DD

addresses

array of objects

required

length between 1 and 1

addresses*

address_type

enum

required

Defaults to PRIMARY

Type of address (Primary or Secondary)

Allowed:

address1

string

required

length ≤ 255

Address line 1 for specified address

address2

string

length ≤ 255

^[^ÅÅÅ¸Ë]{1,60}$

Address line 2 for specified address

city

string

required

length ≤ 50

City of specified address

region

string

required

length ≤ 50

State or Province name

postal_code

int32

required

Zip Code or Postal Code of address

country

string

required

length ≤ 3

Defaults to USA

ISO 3166-3 Alpha

new_card_attributes

object

identification_docs

array of objects

required

length between 1 and 1

identification_docs*

identification_type

string

enum

required

Type of ID provided for cardholder

'SSN' - US SSN
'SIN' - Canada SIN
'NIN' - Other national id
'TIN' - Taxpayer identification
'PASSPORT' - Any country, assume foreign
'DRIVING LICENSE' - For US only with _ST (state) in country field
'CONSULAR' - For foreign, consular ID
'VOTER' - US only, voter ID
'MILITARY ID' - Military ID, US only
'GOVERNMENT ISSUED ID' - Other Government-issued ID

identification_value

string

required

Number of identification document

identification_issuance_country

string

required

ISO 3166-3 Alpha

identification_issuance_region

string

State or Province name

identification_expiry_date

string

Date of expiry of ID i.e. when this ID will expire. Format yyyy-mm-dd. Required if identification_type is PASSPORT or DRIVING LICENSE

identification_document_url

string

Identification document soft-copy location

additional_data

object

external_ref_no

string

required

Merchant's unique reference number

citizenship_country_code

string

required

ISO 3166-3 Alpha

additional_data

object

Headers

x-api-key

string

required

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200