Skip to main content
GET
Client configuration

GET /client-config

Retrieve mandatory customer fields, test-period status, and subscription availability. Send Authorization: Bearer YOUR_API_KEY and X-Device-ID: YOUR_DEVICE_ID. See authentication. Map mandatoryCustomerFields.name to customer.contact.fullName and phone to customer.contact.phone. The address flag requires the nested address data. See customer data. hasSubscription reports whether the subscription status is active. testPeriodStatus reports whether the test window is open, how many cards have been used, the maximum count, and its expiration. Check these values before offering test or real card issuance.

Example request

Example response

Authorizations

Authorization
string
header
required

Location API key. Also requires X-Device-ID.

Headers

X-Device-ID
string
required

Stable device identifier. API key binds to this value on first use.

Response

Success

mandatoryCustomerFields
object
testPeriodStatus
object
hasSubscription
boolean