Retrieve Customers

Retrieve customers matching the provided query parameters

SecurityOAuth2: OAuth2Flow

Request

query Parameters

page	integer <int32> Page of records to get (default 0 = first page)
page_size	integer <int32> Records to return per page (default = 20)
type	string Type of Customer Enum: "INDIVIDUAL" "CORPORATION"
status	string `ACTIVE` - Customer is active and available for use in line with client configuration. `CLOSED` - Customer is permanently closed, no further actions can be performed on it or associated accounts. `PENDING` - Customer is under additional review. No actions can be performed on the account. `FROZEN` - Customer and associated accounts have been temporarily locked for all actions. `EDD` - Customer requires enhanced due diligence to be performed. The customer and accounts will operate as if frozen. `DORMANT` - No activity has been seen in the last 12 months. Customer and accounts are available for use. Enum: "ACTIVE" "CLOSED" "FROZEN" "PENDING" "EDD" "DORMANT"

header Parameters

Authorization	string OAuth bearer token (see authentication flows)
x-l2f-request-id	string Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

get/v1/customers

Response samples

application/json

{"data": {"customers": [{"id": "string",
"customer_type": "INDIVIDUAL",
"status": "ACTIVE"
}
]
},
"links": {"self": "string",
"first": "string",
"prev": "string",
"next": "string",
"last": "string"
}
}