{
"customers": [
{
"account_type": "string",
"alias_ids": [
"string"
],
"comment": "string",
"company_name": "string",
"contacts": "any",
"date_of_birth": "string",
"disabled": "boolean",
"domicile_codes": [
"string"
],
"external_id": "string",
"fields": "object",
"first_name": "string",
"kyc_level": "integer",
"kyc_level_requested": "integer",
"last_name": "string",
"middle_name": "string",
"nationality_codes": [
"string"
],
"parent_external_id": "string",
"phone": "string",
"registration_number": "string",
"review_groups": "any",
"trading_name": "string",
"variations": [
{
"_op": "string",
"company_name": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"trading_name": "string"
}
]
}
],
"disable_risk_scan": "boolean",
"relations": [
{
"child_customer_external_id": "string",
"disabled": "boolean",
"fields": "object",
"parent_customer_external_id": "string",
"relation_external_id": "string",
"relation_type": "integer"
}
],
"verify_input": "boolean"
}
const response = await fetch(
"POST /api/v1/customers/save",
{
method: "post",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer {token}`
},
body: JSON.stringify({
"customers": [
{
"account_type": "string",
"alias_ids": [
"string"
],
"comment": "string",
"company_name": "string",
"contacts": "any",
"date_of_birth": "string",
"disabled": "boolean",
"domicile_codes": [
"string"
],
"external_id": "string",
"fields": "object",
"first_name": "string",
"kyc_level": "integer",
"kyc_level_requested": "integer",
"last_name": "string",
"middle_name": "string",
"nationality_codes": [
"string"
],
"parent_external_id": "string",
"phone": "string",
"registration_number": "string",
"review_groups": "any",
"trading_name": "string",
"variations": [
{
"_op": "string",
"company_name": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"trading_name": "string"
}
]
}
],
"disable_risk_scan": "boolean",
"relations": [
{
"child_customer_external_id": "string",
"disabled": "boolean",
"fields": "object",
"parent_customer_external_id": "string",
"relation_external_id": "string",
"relation_type": "integer"
}
],
"verify_input": "boolean"
})
}
);
{
"added": [
{
"customer_id": "string",
"external_id": "string"
}
],
"detail": [
{
"errors": [
{
"detail": "string",
"error": "string"
}
],
"external_id": "string",
"warnings": [
{
"detail": "string",
"error": "string"
}
]
}
],
"status": "string",
"verify_input": "boolean"
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
Customer
Save customers
Updates or creates customers based on the input.
POST
/
api
/
v1
/
customers
/
save
{
"customers": [
{
"account_type": "string",
"alias_ids": [
"string"
],
"comment": "string",
"company_name": "string",
"contacts": "any",
"date_of_birth": "string",
"disabled": "boolean",
"domicile_codes": [
"string"
],
"external_id": "string",
"fields": "object",
"first_name": "string",
"kyc_level": "integer",
"kyc_level_requested": "integer",
"last_name": "string",
"middle_name": "string",
"nationality_codes": [
"string"
],
"parent_external_id": "string",
"phone": "string",
"registration_number": "string",
"review_groups": "any",
"trading_name": "string",
"variations": [
{
"_op": "string",
"company_name": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"trading_name": "string"
}
]
}
],
"disable_risk_scan": "boolean",
"relations": [
{
"child_customer_external_id": "string",
"disabled": "boolean",
"fields": "object",
"parent_customer_external_id": "string",
"relation_external_id": "string",
"relation_type": "integer"
}
],
"verify_input": "boolean"
}
const response = await fetch(
"POST /api/v1/customers/save",
{
method: "post",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer {token}`
},
body: JSON.stringify({
"customers": [
{
"account_type": "string",
"alias_ids": [
"string"
],
"comment": "string",
"company_name": "string",
"contacts": "any",
"date_of_birth": "string",
"disabled": "boolean",
"domicile_codes": [
"string"
],
"external_id": "string",
"fields": "object",
"first_name": "string",
"kyc_level": "integer",
"kyc_level_requested": "integer",
"last_name": "string",
"middle_name": "string",
"nationality_codes": [
"string"
],
"parent_external_id": "string",
"phone": "string",
"registration_number": "string",
"review_groups": "any",
"trading_name": "string",
"variations": [
{
"_op": "string",
"company_name": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"trading_name": "string"
}
]
}
],
"disable_risk_scan": "boolean",
"relations": [
{
"child_customer_external_id": "string",
"disabled": "boolean",
"fields": "object",
"parent_customer_external_id": "string",
"relation_external_id": "string",
"relation_type": "integer"
}
],
"verify_input": "boolean"
})
}
);
{
"added": [
{
"customer_id": "string",
"external_id": "string"
}
],
"detail": [
{
"errors": [
{
"detail": "string",
"error": "string"
}
],
"external_id": "string",
"warnings": [
{
"detail": "string",
"error": "string"
}
]
}
],
"status": "string",
"verify_input": "boolean"
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
Body parameters
SaveCustomerInput[]
Show properties
Show properties
string
F (Firm) or N (Individual)
string[]
string
string
any
Same rules than review groups
string
Format YYYY-MM-DD
boolean
string[]
string
Unique to your business - mandatory field
object
Other fields (see custom fields in the backoffice); you must define custom field with your Algoreg representative, you will find the active custom fields in https://[domain].backoffice.algoreg.com/settings/import-setup
string
integer
integer
string
string
string[]
string
string
string
any
Either:
a string separated by either ’;’ or ’,’ character. Ex: “A;B;C,D”
an array of SaveCustomerDeltaArrayItemString
string
boolean
DO not execute scan and risk while importing; it will speedup the import but the risk and scan results will only be available on the next ongoing scan/risk process (usually over night). May be forced to true depending on how many customers are created/updated.
SaveCustomerRelationInput[]
Show properties
Show properties
string
Target entity external ID
boolean
object
Other fields (see custom fields in the backoffice); you must define custom field with your Algoreg representative, you will find the active custom fields in https://[domain].backoffice.algoreg.com/settings/import-setup
string
Source entity external ID
string
Unique to your business
integer
See RelationsTypes
boolean
True to just validate input without persisting data
Response body
- 200
- default
SaveCustomersResponseLineErrors[]
string
boolean
{
"customers": [
{
"account_type": "string",
"alias_ids": [
"string"
],
"comment": "string",
"company_name": "string",
"contacts": "any",
"date_of_birth": "string",
"disabled": "boolean",
"domicile_codes": [
"string"
],
"external_id": "string",
"fields": "object",
"first_name": "string",
"kyc_level": "integer",
"kyc_level_requested": "integer",
"last_name": "string",
"middle_name": "string",
"nationality_codes": [
"string"
],
"parent_external_id": "string",
"phone": "string",
"registration_number": "string",
"review_groups": "any",
"trading_name": "string",
"variations": [
{
"_op": "string",
"company_name": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"trading_name": "string"
}
]
}
],
"disable_risk_scan": "boolean",
"relations": [
{
"child_customer_external_id": "string",
"disabled": "boolean",
"fields": "object",
"parent_customer_external_id": "string",
"relation_external_id": "string",
"relation_type": "integer"
}
],
"verify_input": "boolean"
}
const response = await fetch(
"POST /api/v1/customers/save",
{
method: "post",
headers: {
"Content-Type": "application/json",
"Authorization": `Bearer {token}`
},
body: JSON.stringify({
"customers": [
{
"account_type": "string",
"alias_ids": [
"string"
],
"comment": "string",
"company_name": "string",
"contacts": "any",
"date_of_birth": "string",
"disabled": "boolean",
"domicile_codes": [
"string"
],
"external_id": "string",
"fields": "object",
"first_name": "string",
"kyc_level": "integer",
"kyc_level_requested": "integer",
"last_name": "string",
"middle_name": "string",
"nationality_codes": [
"string"
],
"parent_external_id": "string",
"phone": "string",
"registration_number": "string",
"review_groups": "any",
"trading_name": "string",
"variations": [
{
"_op": "string",
"company_name": "string",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"trading_name": "string"
}
]
}
],
"disable_risk_scan": "boolean",
"relations": [
{
"child_customer_external_id": "string",
"disabled": "boolean",
"fields": "object",
"parent_customer_external_id": "string",
"relation_external_id": "string",
"relation_type": "integer"
}
],
"verify_input": "boolean"
})
}
);
{
"added": [
{
"customer_id": "string",
"external_id": "string"
}
],
"detail": [
{
"errors": [
{
"detail": "string",
"error": "string"
}
],
"external_id": "string",
"warnings": [
{
"detail": "string",
"error": "string"
}
]
}
],
"status": "string",
"verify_input": "boolean"
}
{
"errors": [
{
"code": "string",
"deprecated": "boolean",
"message": "string",
"will_be_deprecated": "boolean"
}
]
}
⌘I