Get Cardholder Profile

get https://evolve-sbx.cardprogramservices.com/cardholders/{cardholder_id}

Used to retrieve a cardholder’s profile

time	status	user agent
Retrieving recent requests…

Loading…

Response

Response body

object

first_name

string

length ≤ 50

First name of cardholder

middle_name

string

length ≤ 50

Middle name of cardholder

last_name

string

length ≤ 50

Last name of cardholder

gender

Gender of cardholder

string

Email address of cardholder

phone_details

array of objects

length between 1 and 1

phone_details

object

phone_type

required

Type of phone provided

country_dialing_code

int32

required

ISO numeric dialing country code

phone_number

string

required

length ≤ 50

Phone number

date_of_birth

date

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

addresses

array of objects

length between 1 and 1

addresses

object

address_type

required

Defaults to PRIMARY

Type of address (Primary or Secondary)

address1

string

required

length ≤ 255

Address line 1 for specified address

address2

string

length ≤ 255

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

citizenship_country_code

string

ISO 3166-3 Alpha

identification_docs

array of objects

length between 1 and 1

identification_docs

object

identification_type

string

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

SSN SIN NIN TIN PASSPORT DRIVING LICENSE CONSULAR VOTER MILITARY ID 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

cards

array of objects

cards

object

card_id

string

Card Identifier

last_four

string

Last four digit of Card Number

status

Info regarding current state of card

program_id

string

Program ID to which this Card belongs

name_on_card

string

Name printed on card of cardholder

external_ref_no

string

Merchant's unique reference number

additional_data

object

kyc_status

string

KYC Status

APPROVED DENIED UNDER_REVIEW UPLOAD_DOCUMENT NOT_AVAILABLE DOCUMENT_ERROR PENDING_OOW_QUESTIONS INCOMPLETE_OOW_ANSWERS

kyc_reason_codes

array of strings

KYC Reason Codes

kyc_reason_codes

kyc_vendor_results

array of objects

length between 1 and 1

kyc_vendor_results

object

kyc_vendor

string

Name of KYC service provider

type

string

Type of kyc vendor code if available

code

string

Code provided by KYC vendor in case of failure or warning

description

string

This describes the code. Field is optional and may or may not be present

external_ref_no

string

Merchant's unique reference number

additional_data

object

kyc_host_eval_token

string

kyc_host_entity_token

string

Headers

object

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://evolve-sbx.cardprogramservices.com/cardholders/ \
3
     --header 'accept: application/json'

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

application/json

200