Get customer detail
curl --request GET \
--url https://api.algoreg.com/api/v1/customers/{customer_external_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.algoreg.com/api/v1/customers/{customer_external_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.algoreg.com/api/v1/customers/{customer_external_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.algoreg.com/api/v1/customers/{customer_external_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.algoreg.com/api/v1/customers/{customer_external_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.algoreg.com/api/v1/customers/{customer_external_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.algoreg.com/api/v1/customers/{customer_external_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
],
"parent_external_id": "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"
}
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
Customer
Get customer detail
Returns the details of a customer.
GET
/
api
/
v1
/
customers
/
{customer_external_id}
Get customer detail
curl --request GET \
--url https://api.algoreg.com/api/v1/customers/{customer_external_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.algoreg.com/api/v1/customers/{customer_external_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.algoreg.com/api/v1/customers/{customer_external_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.algoreg.com/api/v1/customers/{customer_external_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.algoreg.com/api/v1/customers/{customer_external_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.algoreg.com/api/v1/customers/{customer_external_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.algoreg.com/api/v1/customers/{customer_external_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
],
"parent_external_id": "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"
}
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
Path parameters
string
required
Response body
- 200
- default
Customer
Show properties
Show properties
string
CustomerAccountType
Show properties
Show properties
string[]
string
string
string
string
string
integer
object
string
string
boolean
string
string[]
string
string
string
integer
string
string
string
deprecated. Use nationality_codes instead
string[]
string
string
string
string[]
string
string
EDDRevisionDTO
Risk
Show properties
Show properties
{
"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"
],
"parent_external_id": "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"
}
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
⌘I