Risk Analysis

post

For businesses: Anti Money Laundering (AML) involves the identification of suspicious transactions, assessing customer risk, and reporting possible occurrences to authorities. Politically exposed persons (PEP) identifies individuals in prominent public roles, like government officials, who are at higher risk for involvement in financial crimes.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
company_namestringOptional

Company name

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/commercial/amlpep
post

Instantly verifies ID numbers, names, and surnames. Flags suspicious activity by checking the frequency and appropriateness of addresses and phone numbers. Additionally, will notify you of any IDs associated with fraudulent activities.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
id_numberstringOptional

Consumer ID number

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/consumer/hawks
post

For consumers: Anti Money Laundering (AML) involves the identification of suspicious transactions, assessing customer risk, and reporting possible occurrences to authorities. Politically exposed persons (PEP) identifies individuals in prominent public roles, like government officials, who are at higher risk for involvement in financial crimes.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
first_namestringOptional

First name

middle_namestringOptional

Middle name

last_namestringOptional

Last name

dobstring · dateOptional

Date of birth. format: YYYY-MM-DD

genderstringOptional

Gender. M for male, F for female

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/v3/amlpep
post

AML (Anti-Money Laundering) Check operation that screens customers against global watchlists, politically exposed persons lists, and adverse media, helping assess the risk associated with the customer.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2clientCredentialsRequired
Token URL: Refresh URL:
Body
country_codestringOptional

A string representing the customer's known nationalities, formatted as 2-character country codes separated by commas (e.g., 'NG, ZA'). Country codes are as follows: Nigeria = NG, South Africa = ZA, Ghana = GH, and Uganda = UG.

birth_yearstringOptional

The customer's year of birth, in the format YYYY.

full_namestringOptional

The full name of the customer

consentbooleanOptional

By using this API, you acknowledge that you have read, understood, and agree to be bound by these Terms of Service. If you have any questions or concerns, please contact us

Responses
200Success
application/json
post
/api/v2/amlpep

Last updated