Get a consumer
GET
/consumers Returns the consumer associated with the authentication token, including their profile, contact details, and current state.
Read the consumer overview for the consumer lifecycle and onboarding flow.
Request
No request parametersThis endpoint doesn’t accept query parameters or a request body.
Responses
200OK
Success
Headers
Body
application/json
ConsumerConsumer · object · 11 fields
Response example
{ "id": { "type": "CONSUMER", "id": "123456789" }, "profileId": "10001", "tag": "customer-123", "rootUser": { "id": { "type": "CONSUMER", "id": "123456789" }, "name": "string", "surname": "string", "email": "[email protected]", "mobile": { "countryCode": "+44", "number": "7700900123" }, "occupation": "ACCOUNTING", "active": true, "emailVerified": true, "mobileNumberVerified": true, "dateOfBirth": { "year": 1990, "month": 1, "day": 1 }, "address": { "addressLine1": "string", "addressLine2": "string", "city": "string", "postCode": "string", "state": "string", "country": "string" }, "nationality": {}, "placeOfBirth": "string", "tag": "customer-123", "locale": "en-GB", "brand": "string" }, "creationTimestamp": 0, "ipAddress": "string", "acceptedTerms": true, "baseCurrency": "GBP", "feeGroup": "string", "sourceOfFunds": "PERSONAL_SAVINGS", "sourceOfFundsOther": "string"}