Consumer

Get Consumer

GET

Get the consumer data from the consumer_external_id provided by the partner

Path parameters

consumer_external_idstringRequired

Response

This endpoint returns an object
id
string
pcid
string
kyc_status
string
phone_number
string
date_of_birth
string
tax_id_type
string
address_line1
string
address_line2
string
address_city
string
address_state
string
address_zip
string
first_name
stringOptional
last_name
stringOptional
email
stringOptional
is_active
booleanOptional
tax_identifier
stringOptional
credit_lines
stringOptional
GET
1curl /v2/consumer/consumer_external_id/ \
2 -H "Authorization: Bearer <token>"
200
Retrieved
1{
2 "id": "id",
3 "pcid": "pcid",
4 "kyc_status": "kyc_status",
5 "phone_number": "phone_number",
6 "date_of_birth": "date_of_birth",
7 "tax_id_type": "tax_id_type",
8 "address_line1": "address_line1",
9 "address_line2": "address_line2",
10 "address_city": "address_city",
11 "address_state": "address_state",
12 "address_zip": "address_zip",
13 "first_name": "first_name",
14 "last_name": "last_name",
15 "email": "email",
16 "is_active": true,
17 "tax_identifier": "tax_identifier",
18 "credit_lines": "credit_lines"
19}