API ReferenceConsumers

Retrieve Consumer

Get the consumer data from the consumer_external_id provided by the partner

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

consumer_external_idstringRequired

Response

idstringformat: "uuid"
pcidstring
mla_statusboolean
external_idstringOptionalformat: "uuid"
first_namestring or nullOptional<=255 characters
last_namestring or nullOptional<=255 characters
emailstring or nullOptionalformat: "email"<=255 characters
is_activebooleanOptional
kyc_statusstringOptionalRead-only
phone_numberstringOptionalRead-only
date_of_birthstringOptionalRead-only
tax_id_typestringOptionalRead-only
tax_identifierstring or nullOptionalRead-only
address_line1stringOptionalRead-only
address_line2stringOptionalRead-only
address_citystringOptionalRead-only
address_statestringOptionalRead-only
address_zipstringOptionalRead-only
credit_linesstring or nullOptionalRead-only