Customer
Search customers
Get Started
Customer
Customer Document
Go!Chat
Go!KYT
Go!Press
Go!Scan
Go!Vid
Appendix
Customer
Search customers
Searches for customers that match the input.
POST
/
api
/
v1
/
customers
{
"account_types": [
"string"
],
"assigned_to_member_id": "integer",
"disabled": "boolean",
"edd_state": [
{}
],
"external_id": "string",
"limit": "integer",
"offset": "integer",
"only_without_assignment": "boolean",
"only_without_review_groups": "boolean",
"order_by": "string",
"order_way": "string",
"prefix": "string",
"review_groups": [
"string"
],
"risk": [
{}
],
"search": "string"
}
{
"data": [
{
"account_type": "integer",
"company_name": "string",
"concat_name": "string",
"created_by_agent": "integer",
"customer_id": "string",
"customer_revision_creation_date": "string",
"customer_revision_id": "string",
"disabled": "boolean",
"domicile_code": "string",
"domicile_codes": [
"string"
],
"edd_state": {},
"external_id": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"nationality_code": "string",
"nationality_codes": [
"string"
],
"risk": {},
"sort_name": "string",
"trading_name": "string"
}
],
"total": "integer"
}
Body parameters
Response body
deprecated. Use nationality_codes instead
{
"account_types": [
"string"
],
"assigned_to_member_id": "integer",
"disabled": "boolean",
"edd_state": [
{}
],
"external_id": "string",
"limit": "integer",
"offset": "integer",
"only_without_assignment": "boolean",
"only_without_review_groups": "boolean",
"order_by": "string",
"order_way": "string",
"prefix": "string",
"review_groups": [
"string"
],
"risk": [
{}
],
"search": "string"
}
{
"data": [
{
"account_type": "integer",
"company_name": "string",
"concat_name": "string",
"created_by_agent": "integer",
"customer_id": "string",
"customer_revision_creation_date": "string",
"customer_revision_id": "string",
"disabled": "boolean",
"domicile_code": "string",
"domicile_codes": [
"string"
],
"edd_state": {},
"external_id": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"nationality_code": "string",
"nationality_codes": [
"string"
],
"risk": {},
"sort_name": "string",
"trading_name": "string"
}
],
"total": "integer"
}
{
"account_types": [
"string"
],
"assigned_to_member_id": "integer",
"disabled": "boolean",
"edd_state": [
{}
],
"external_id": "string",
"limit": "integer",
"offset": "integer",
"only_without_assignment": "boolean",
"only_without_review_groups": "boolean",
"order_by": "string",
"order_way": "string",
"prefix": "string",
"review_groups": [
"string"
],
"risk": [
{}
],
"search": "string"
}
{
"data": [
{
"account_type": "integer",
"company_name": "string",
"concat_name": "string",
"created_by_agent": "integer",
"customer_id": "string",
"customer_revision_creation_date": "string",
"customer_revision_id": "string",
"disabled": "boolean",
"domicile_code": "string",
"domicile_codes": [
"string"
],
"edd_state": {},
"external_id": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"nationality_code": "string",
"nationality_codes": [
"string"
],
"risk": {},
"sort_name": "string",
"trading_name": "string"
}
],
"total": "integer"
}