Customer
Get customer detail
Get Started
Customer
Customer Document
Go!Chat
Go!KYT
Go!Press
Go!Scan
Go!Vid
Appendix
Customer
Get customer detail
Returns the details of a customer.
GET
/
api
/
v1
/
customers
/
{customer_external_id}
curl --request GET \
--url https://api.algoreg.com/api/v1/customers/{customer_external_id} \
--header 'Authorization: Bearer <token>'
{
"closed_chat_categories": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"custom_fields": [
{
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
}
],
"customer": {
"account_number": "string",
"account_type": {},
"alias_ids": [
"string"
],
"client_id": "string",
"comment": "string",
"company_name": "string",
"contacts": "string",
"created_at": "string",
"created_by": "integer",
"custom_fields": "object",
"customer_type": "string",
"date_of_birth": "string",
"disabled": "boolean",
"domicile_code": "string",
"domicile_codes": [
"string"
],
"external_id": "string",
"first_name": "string",
"id": "string",
"kyc_level": "integer",
"last_name": "string",
"middle_name": "string",
"name_variations": [
{
"company_name": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"trading_name": "string"
}
],
"nationality_code": "string",
"nationality_codes": [
"string"
],
"phone": "string",
"registration_number": "string",
"review_groups": [
"string"
],
"revision_number": "string",
"trading_name": "string"
},
"edd_status": {
"agent_id": "integer",
"agent_name": "string",
"client_id": "integer",
"comment": "string",
"created_at": "string",
"customer_id": "string",
"disabled": "boolean",
"edd_state": {},
"id": "integer",
"next_review_date": "string",
"revision_number": "integer"
},
"may_be_pep": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"may_be_press_risk": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"may_be_san": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"open_chat_categories": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"overall_risk": {},
"pep": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"press_risk": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"se": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"str": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"tm": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_failed": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_in_progress": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_outdated": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_success": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
}
}
Path parameters
Response body
deprecated. Use nationality_codes instead
{
"closed_chat_categories": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"custom_fields": [
{
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
}
],
"customer": {
"account_number": "string",
"account_type": {},
"alias_ids": [
"string"
],
"client_id": "string",
"comment": "string",
"company_name": "string",
"contacts": "string",
"created_at": "string",
"created_by": "integer",
"custom_fields": "object",
"customer_type": "string",
"date_of_birth": "string",
"disabled": "boolean",
"domicile_code": "string",
"domicile_codes": [
"string"
],
"external_id": "string",
"first_name": "string",
"id": "string",
"kyc_level": "integer",
"last_name": "string",
"middle_name": "string",
"name_variations": [
{
"company_name": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"trading_name": "string"
}
],
"nationality_code": "string",
"nationality_codes": [
"string"
],
"phone": "string",
"registration_number": "string",
"review_groups": [
"string"
],
"revision_number": "string",
"trading_name": "string"
},
"edd_status": {
"agent_id": "integer",
"agent_name": "string",
"client_id": "integer",
"comment": "string",
"created_at": "string",
"customer_id": "string",
"disabled": "boolean",
"edd_state": {},
"id": "integer",
"next_review_date": "string",
"revision_number": "integer"
},
"may_be_pep": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"may_be_press_risk": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"may_be_san": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"open_chat_categories": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"overall_risk": {},
"pep": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"press_risk": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"se": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"str": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"tm": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_failed": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_in_progress": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_outdated": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_success": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
}
}
curl --request GET \
--url https://api.algoreg.com/api/v1/customers/{customer_external_id} \
--header 'Authorization: Bearer <token>'
{
"closed_chat_categories": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"custom_fields": [
{
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
}
],
"customer": {
"account_number": "string",
"account_type": {},
"alias_ids": [
"string"
],
"client_id": "string",
"comment": "string",
"company_name": "string",
"contacts": "string",
"created_at": "string",
"created_by": "integer",
"custom_fields": "object",
"customer_type": "string",
"date_of_birth": "string",
"disabled": "boolean",
"domicile_code": "string",
"domicile_codes": [
"string"
],
"external_id": "string",
"first_name": "string",
"id": "string",
"kyc_level": "integer",
"last_name": "string",
"middle_name": "string",
"name_variations": [
{
"company_name": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"trading_name": "string"
}
],
"nationality_code": "string",
"nationality_codes": [
"string"
],
"phone": "string",
"registration_number": "string",
"review_groups": [
"string"
],
"revision_number": "string",
"trading_name": "string"
},
"edd_status": {
"agent_id": "integer",
"agent_name": "string",
"client_id": "integer",
"comment": "string",
"created_at": "string",
"customer_id": "string",
"disabled": "boolean",
"edd_state": {},
"id": "integer",
"next_review_date": "string",
"revision_number": "integer"
},
"may_be_pep": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"may_be_press_risk": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"may_be_san": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"open_chat_categories": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"overall_risk": {},
"pep": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"press_risk": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"se": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"str": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"tm": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_failed": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_in_progress": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_outdated": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
},
"vid_success": {
"fieldtype": {},
"id": "integer",
"name": "string",
"value": "any"
}
}