Skip to main content

Get Customer

Use this endpoint to retrieve details of a given customer. This is a GET request.

Headers

    Content-Type String - (Required)
    application-json

    Accept String - (Required)
    application-json

    Authorization String - (Required)
    Bearer {ACCESS_TOKEN} (See Authentication)

Parameters

    CUSTOMER_ID String (part of URL) - (Required)
    The specific Customer ID to retrieve

Returns

    id String
    The customer ID

    firstName String
    Customer's first name

    lastName String
    Customer's last name

    email String
    Customer's email

    customerStatus enum
    ACTIVE or CREATED or INACTIVE

    accountDetails object
    Details of customer’s bank account

Get Request

GET - /v1/customers/{CUSTOMER_ID}
GET Request
1curl --location --request GET '{API_BASE_URL}/v1/customers/{CUSTOMER_ID}' \
2--header 'Content-Type: application/json' \
3--header 'Accept: application/json' \
4--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response Body

Response
1{ 
2	"id": "string", 
3	"firstName": "string", 
4	"lastName": "string", 
5	"email": "string", 
6	"customerStatus": "string", 
7	"accountDetails": { 
8		"financialInstitutionName": "string", 
9		"accountLastFourDigits": "string", 
10		"accountType": "string", 
11		"accountStatus": "string", 
12		"preferred": boolean, 
13		"creationDate": "2022-05-27T19:46:24.548Z" 
14	}, 
15	"creationDate": "2022-05-27T19:46:24.548Z" 
16}