Go!Scan
Get alert detail
Get Started
Customer
Customer Document
Go!Chat
Go!KYT
Go!Press
Go!Scan
Go!Vid
Appendix
Go!Scan
Get alert detail
Returns the details of an alert.
GET
/
api
/
v1
/
alerts
/
{alert_id}
curl --request GET \
--url https://api.algoreg.com/api/v1/alerts/{alert_id} \
--header 'Authorization: Bearer <token>'
{
"created_at": "string",
"customer_external_id": "string",
"id": "string",
"last_revision": {
"agent_id": "string",
"associates": [
{
"association_type_code": "integer",
"association_type_label": "string",
"list_id": "string"
}
],
"comment": "string",
"created_at": "string",
"customer_revision_id": "string",
"id": "string",
"is_pep": "boolean",
"is_rca": "boolean",
"is_rca_pep": "boolean",
"is_rca_san": "boolean",
"is_rca_sie": "boolean",
"is_rca_sip": "boolean",
"is_rca_soe": "boolean",
"is_rca_sop": "boolean",
"is_san": "boolean",
"is_sie": "boolean",
"is_sip": "boolean",
"is_soe": "boolean",
"is_sop": "boolean",
"list_name": "string",
"list_profile": {
"addresses": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"birth_place": [
"string"
],
"company_details": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"countries": [
{
"codes": [
"string"
],
"country_type": "string",
"country_type_code": "integer",
"iso3_codes": [
"string"
],
"names": [
"string"
]
}
],
"date": "string",
"date_formated": "string",
"dates": [
{
"date_type": "string",
"date_type_code": "integer",
"date_values": [
{
"day": "string",
"dnote": "string",
"formated": "string",
"month": "string",
"year": "string"
}
]
}
],
"deceased": "boolean",
"descriptions": {
"descriptions1": [
{
"id": "string",
"text": "string"
}
],
"descriptions2": [
{
"id": "string",
"text": "string"
}
],
"descriptions3": [
{
"id": "string",
"text": "string"
}
]
},
"gender": "string",
"id_number_type": [
{
"id_type": "string",
"id_values": [
{
"id_notes": "string",
"value": "string"
}
]
}
],
"images": [
"string"
],
"list_id": "string",
"names": [
{
"name_type": "string",
"name_type_code": "integer",
"name_values": [
{
"entity_name": [
"string"
],
"first_name": [
"string"
],
"maiden_name": [
"string"
],
"middle_name": [
"string"
],
"original_script_name": [
"string"
],
"single_string_name": [
"string"
],
"suffix": [
"string"
],
"surname": [
"string"
],
"title_honorific": [
"string"
]
}
]
}
],
"profile_notes": "string",
"roles": [
{
"occupations": [
{
"category": "string",
"code": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"title": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"role_type": "string",
"role_type_code": "integer"
}
],
"sanctions": [
{
"reference": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"sources": [
"string"
],
"status": "string",
"type": "string",
"vessels": [
{
"vessel_call_sign": "string",
"vessel_flag": "string",
"vessel_grt": "string",
"vessel_owner": "string",
"vessel_tonnage": "string",
"vessel_type": "string"
}
]
},
"profile_date": "integer",
"revision_number": "integer",
"score": "integer",
"state": "integer",
"top_category": "string"
},
"profile_number": "string",
"revisions": [
{
"agent_id": "string",
"comment": "string",
"created_at": "string",
"customer_revision_id": "string",
"id": "string",
"profile_date": "integer",
"revision_number": "integer",
"score": "integer",
"state": "integer",
"top_category": "string"
}
]
}
Path parameters
Response body
Record update date
Record update date formatted
See NameTypes
See NameTypes
Name of the firm or non-individual entity
null or list of strings
null or list of strings
null or list of strings
Name in original alphabet
All names concatenated in one string
null or list of strings
null or list of strings
Additional notes
Source url, newspaper links etc
Overall match score between 0 and 100
PEP, SAN, SIP, RCA_SIP, etc
{
"created_at": "string",
"customer_external_id": "string",
"id": "string",
"last_revision": {
"agent_id": "string",
"associates": [
{
"association_type_code": "integer",
"association_type_label": "string",
"list_id": "string"
}
],
"comment": "string",
"created_at": "string",
"customer_revision_id": "string",
"id": "string",
"is_pep": "boolean",
"is_rca": "boolean",
"is_rca_pep": "boolean",
"is_rca_san": "boolean",
"is_rca_sie": "boolean",
"is_rca_sip": "boolean",
"is_rca_soe": "boolean",
"is_rca_sop": "boolean",
"is_san": "boolean",
"is_sie": "boolean",
"is_sip": "boolean",
"is_soe": "boolean",
"is_sop": "boolean",
"list_name": "string",
"list_profile": {
"addresses": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"birth_place": [
"string"
],
"company_details": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"countries": [
{
"codes": [
"string"
],
"country_type": "string",
"country_type_code": "integer",
"iso3_codes": [
"string"
],
"names": [
"string"
]
}
],
"date": "string",
"date_formated": "string",
"dates": [
{
"date_type": "string",
"date_type_code": "integer",
"date_values": [
{
"day": "string",
"dnote": "string",
"formated": "string",
"month": "string",
"year": "string"
}
]
}
],
"deceased": "boolean",
"descriptions": {
"descriptions1": [
{
"id": "string",
"text": "string"
}
],
"descriptions2": [
{
"id": "string",
"text": "string"
}
],
"descriptions3": [
{
"id": "string",
"text": "string"
}
]
},
"gender": "string",
"id_number_type": [
{
"id_type": "string",
"id_values": [
{
"id_notes": "string",
"value": "string"
}
]
}
],
"images": [
"string"
],
"list_id": "string",
"names": [
{
"name_type": "string",
"name_type_code": "integer",
"name_values": [
{
"entity_name": [
"string"
],
"first_name": [
"string"
],
"maiden_name": [
"string"
],
"middle_name": [
"string"
],
"original_script_name": [
"string"
],
"single_string_name": [
"string"
],
"suffix": [
"string"
],
"surname": [
"string"
],
"title_honorific": [
"string"
]
}
]
}
],
"profile_notes": "string",
"roles": [
{
"occupations": [
{
"category": "string",
"code": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"title": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"role_type": "string",
"role_type_code": "integer"
}
],
"sanctions": [
{
"reference": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"sources": [
"string"
],
"status": "string",
"type": "string",
"vessels": [
{
"vessel_call_sign": "string",
"vessel_flag": "string",
"vessel_grt": "string",
"vessel_owner": "string",
"vessel_tonnage": "string",
"vessel_type": "string"
}
]
},
"profile_date": "integer",
"revision_number": "integer",
"score": "integer",
"state": "integer",
"top_category": "string"
},
"profile_number": "string",
"revisions": [
{
"agent_id": "string",
"comment": "string",
"created_at": "string",
"customer_revision_id": "string",
"id": "string",
"profile_date": "integer",
"revision_number": "integer",
"score": "integer",
"state": "integer",
"top_category": "string"
}
]
}
curl --request GET \
--url https://api.algoreg.com/api/v1/alerts/{alert_id} \
--header 'Authorization: Bearer <token>'
{
"created_at": "string",
"customer_external_id": "string",
"id": "string",
"last_revision": {
"agent_id": "string",
"associates": [
{
"association_type_code": "integer",
"association_type_label": "string",
"list_id": "string"
}
],
"comment": "string",
"created_at": "string",
"customer_revision_id": "string",
"id": "string",
"is_pep": "boolean",
"is_rca": "boolean",
"is_rca_pep": "boolean",
"is_rca_san": "boolean",
"is_rca_sie": "boolean",
"is_rca_sip": "boolean",
"is_rca_soe": "boolean",
"is_rca_sop": "boolean",
"is_san": "boolean",
"is_sie": "boolean",
"is_sip": "boolean",
"is_soe": "boolean",
"is_sop": "boolean",
"list_name": "string",
"list_profile": {
"addresses": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"birth_place": [
"string"
],
"company_details": [
{
"address_city": "string",
"address_country": "string",
"address_line": "string",
"url": "string"
}
],
"countries": [
{
"codes": [
"string"
],
"country_type": "string",
"country_type_code": "integer",
"iso3_codes": [
"string"
],
"names": [
"string"
]
}
],
"date": "string",
"date_formated": "string",
"dates": [
{
"date_type": "string",
"date_type_code": "integer",
"date_values": [
{
"day": "string",
"dnote": "string",
"formated": "string",
"month": "string",
"year": "string"
}
]
}
],
"deceased": "boolean",
"descriptions": {
"descriptions1": [
{
"id": "string",
"text": "string"
}
],
"descriptions2": [
{
"id": "string",
"text": "string"
}
],
"descriptions3": [
{
"id": "string",
"text": "string"
}
]
},
"gender": "string",
"id_number_type": [
{
"id_type": "string",
"id_values": [
{
"id_notes": "string",
"value": "string"
}
]
}
],
"images": [
"string"
],
"list_id": "string",
"names": [
{
"name_type": "string",
"name_type_code": "integer",
"name_values": [
{
"entity_name": [
"string"
],
"first_name": [
"string"
],
"maiden_name": [
"string"
],
"middle_name": [
"string"
],
"original_script_name": [
"string"
],
"single_string_name": [
"string"
],
"suffix": [
"string"
],
"surname": [
"string"
],
"title_honorific": [
"string"
]
}
]
}
],
"profile_notes": "string",
"roles": [
{
"occupations": [
{
"category": "string",
"code": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"title": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"role_type": "string",
"role_type_code": "integer"
}
],
"sanctions": [
{
"reference": "string",
"since_day": "string",
"since_formated": "string",
"since_month": "string",
"since_year": "string",
"to_day": "string",
"to_formated": "string",
"to_month": "string",
"to_year": "string"
}
],
"sources": [
"string"
],
"status": "string",
"type": "string",
"vessels": [
{
"vessel_call_sign": "string",
"vessel_flag": "string",
"vessel_grt": "string",
"vessel_owner": "string",
"vessel_tonnage": "string",
"vessel_type": "string"
}
]
},
"profile_date": "integer",
"revision_number": "integer",
"score": "integer",
"state": "integer",
"top_category": "string"
},
"profile_number": "string",
"revisions": [
{
"agent_id": "string",
"comment": "string",
"created_at": "string",
"customer_revision_id": "string",
"id": "string",
"profile_date": "integer",
"revision_number": "integer",
"score": "integer",
"state": "integer",
"top_category": "string"
}
]
}