Get lookup values
Method Description
Endpoint
Request Type | URL |
|---|---|
GET | https://{EnvironmentURL}/kycp/lookups/{id} |
Headers
Parameter | Type | Mandatory | Description |
|---|---|---|---|
x-api-version | string | Yes | 1.0 |
Request parameters
Path parameters
Parameter | Type | Mandatory | Description |
|---|---|---|---|
id | int | Yes | Identifier of the Lookup. Necessary Lookup IDs are described for each method |
Query parameters
Parameter | Type | Mandatory | Description |
|---|---|---|---|
filter | string | No | Filter by name |
pageNumber | int | No | Pagination parameter |
pageSize | int | No | Pagination parameter |
Responses
200 OK - Success
Body - JSON
Wrapper - Paginated Response
Parameter | Type | Mandatory | Description |
|---|---|---|---|
pageNumber | int | Yes | Pagination parameter |
pageSize | int | Yes | Pagination parameter |
total | int | Yes | Total number of objects in the list |
data | object | Yes | Response |
data - collection of Lookup entities
Parameter | Type | Mandatory | Description |
|---|---|---|---|
id | int | Yes | Identifier of Lookup Value |
externalRef | string | No | Additional external value for lookup. Used to store conutry codes |
name | String | Non Mandatory | Value of the Lookup |