Argos KYC
Search…
API Documents

ARGOS REST API

You can submit your customers KYC form data using the Argos API and check the progress of KYC.
The Argos API uses RESTful Endpoints and the default HTTP Method.
  • The response data contains the status of the request and possible error codes.
  • All response data is provided as JSON format.
  • Use token authentication.
  • All requests must be made in HTTPS. HTTP requests will fail.

Authentication

The API uses Token-based authentication.
The API must be provided by Argos in order to use the API. The API Key should be included in the method request header as
'x-api-key: hTRgZTc6UR2FLgIh5tKLsyjO89xBsiWG3pz3eYvc'.

Example

curl -H "x-api-key:hTRgZTc6UR2FLgIh5tKLsyjO89xBsiWG3pz3eYvc" https://api2.argos-solutions.io/f1/submissions

Errors

Respond with a generic HTTP response code. At success, it is represented by 2xx code. 4xx occurs when there is an error in the information transmitted on the Client. 5xx occurs when there is an error on the Argos server.
HTTP Code
Message
Description
400
Invalid Query String parameters
Client error (e.g. malformed request syntax, invalid request message framing)
403
Forbidden
API KEY is not provided or something is wrong with the API KEY.
413
Request Entity Too Large
The request is larger than the server is willing or able to process.
500
Internal Server Error
It might be Argos server error. Please contact Argos team.
502
Bad Gateway
The server received an invalid response from the upstream server.

GET Submission Data

The KYC / AML status can be checked by the GET request. You can either check for the KYC status of a specific submission or get a list of kyc submissions with GET request.

GET one item : query a specific submission

Get form data that a specific KYC applicant has filled in. To get form data of a specific applicant, your argument must include one of the followings: KYC applicant&'s email address, submission id, or userid. If there are multiple submissions with the same email address, the latest submission data is returned. If submission ID is included in the argument, submission data with matching submission id is returned. For example, when a submission id is requested, the data corresponding to that submission id will be returned.
Endpoint : GET submission data
  • When using email only GET https://api2.argos-solutions.io/f1/submissions?email={email}
  • When using submission id only GET https://api2.argos-solutions.io/f1/submissions?submission_id={submission id}
  • When using user id only GET https://api2.argos-solutions.io/f1/submissions?userid={userid}
  • When using email and submission ID GET https://api2.argos-solutions.io/f1/submissions?email={email}&submission_id={submission id}

Arguments

Argument
Description
email
Email address of KYC applicant to check submission data
submission_id
Submission id received in response to POST submission data
userid
Customizable identifier

Response

Could not load image
Example
1
curl -H "x-api-key:hTRgZTc6UR2FLgIh5tKLsyjO89xBqsWG3pz3eYvc" https://api2.argos-solutions.io/f1/[email protected]
Copied!
Sample Response
1
{
2
"Items": [
3
{
4
"data": {
5
"first_name": "test",
6
"last_name": "test",
7
"gender": "male",
8
"nationality": "United States, USA",
9
"date_of_birth": "2020-07-02",
10
"address_city": "Pittsburgh",
11
"address_country": "United States, USA",
12
"address_state": "PA",
13
"address_street": "5000 Forbes Ave",
14
"address_zipcode": "15213"
15
},
16
"email": "[email protected]",
17
"submission_id": "19lwz38kczv2mnw",
18
"created_at": "2020-07-24 06:46",
19
"userid": "your_user_id",
20
"kyc": {
21
"result": "pending"
22
}
23
}
24
]
25
}
Copied!

GET List : Check all submissions

The data is returned in alphabetical order following id and "created_at" fields. This api is to get a list of all submissions and their form data.
Check all submissions GET https://api2.argos-solutions.io/f1/submissions

Response

Could not load image
argos_api_get_list.png
Example
1
curl -H "x-api-key:hTRgZTc6UR2FLgIh5tKLsyjO89xBqsWG3pz3eYvc" https://api2.argos-solutions.io/f1/submissions
Copied!
Sample Response
1
{
2
"Items": [
3
{
4
"data": {
5
"first_name": "John",
6
"last_name": "Smith",
7
"gender": "male",
8
"nationality": "Australia, AUS",
9
"date_of_birth": "1990-06-10"
10
},
11
"email": "[email protected]",
12
"submission_id": "g3so8kcybubmp",
13
"submit_date": "2017-07-23 05:00",
14
"kyc": {
15
"result": "approved"
16
},
17
"aml": "Not Screened"
18
},
19
{
20
"data": {
21
"first_name": "Donald",
22
"last_name": "Trump",
23
"gender": "male",
24
"nationality": "United States, USA",
25
"date_of_birth": "1946-06-14"
26
},
27
"email": "[email protected]",
28
"submission_id": "japc8kclg6sn5",
29
"submit_date": "2020-07-14 04:41",
30
"kyc": {
31
"result": "approved"
32
},
33
"aml": "Red Flag"
34
}
35
]
36
}
Copied!

POST Submission(s)

Argos KYC (a.k.a. Know Your Customer) verifies your customer's information with their provided documents. You have options to choose from two different tiers of KYC depending on whether you need to verify the customer's address information.

KYC Level 1

KYC Level 1 is to verify the customer's ID document and identity using ID verification and face verification. For KYC level 1 verification, you must first upload ID image and Selfie image then include their filehash in submission form data.

Step 1. Upload ID image

  1. 1.
    Upload an image with type value of "passport" "drivers_license" or "government_id".
  2. 2.
    Copy "filehash" value from response object and store it for later use. **This value is required when submitting the form data in Step 3.
Request Type
Request URL
POST
https://api2.argos-solutions.io/f1/submissions/upload
Request Headers
1
headers = {
2
'x-api-key' : 'your_api_key'
3
'Content-Type' : 'multipart/form-data; boundary=<your_file_boundary>'
4
}
Copied!
Sample Code
Caution : If you would like to send a cURL POST request to API directly, image files need to be base64-encoded and boundary should be included in the headers. cURL
1
curl --location --request POST 'https://api2.argos-solutions.io/f1/submissions/upload' \
2
--header 'x-api-key: <your_api_key_here>' \
3
--header ‘Content-Type’: 'multipart/form-data; boundary= <file_boundary>’ \
4
--form '[email protected]/<your_file_path_here>' \
5
--form 'type=passport'
Copied!
Node.js - Request
1
var request = require('request');
2
var fs = require('fs');
3
var options = {
4
'method': 'POST',
5
'url': 'api2.argos-solutions.io/f1/submissions/upload',
6
'headers': {
7
'x-api-key': '<your_api_key_here>'
8
'Content-Type': 'multipart/form-data;boundary=<file_boundary>'
9
},
10
formData: {
11
'file': {
12
'value': fs.createReadStream('<your_file_path_here>'),
13
'options': {
14
'filename': '<file_name_here>',
15
'contentType': null
16
}
17
},
18
'type': 'passport'
19
}
20
};
21
22
request(options, function (error, response) {
23
if (error) throw new Error(error);
24
console.log(response.body);
25
});
Copied!
Arguments
Argument
Description
Required
file
The file which needs to be uploaded ( multipart form )
Yes
type
Possible document types: passport, drivers_license, government_id, selfie, address, other
Yes
"other" value in "type" refers to any additional image to store in Submission object (jpeg, png, pdf).
Response Object
Parameter
Description
Format
id
Document ID
text
created_at
Created date time
ISO8601
filehash
The file hash id that has been uploaded to Argos system when you submit the form data, this value used for photoid_res, selfie_res, address_res fields
text
filetype
Possible document types: &lt;passport, drivers_license, government_id, selfie, address&gt;
text
Example
1
curl -H "x-api-key:hTRgZTc6UR2FLgIh5tKLsyjO89xBsiWG3pz3eYvc" -F "type=passport" -F "[email protected];type=image/png" https://api2.argos-solutions.io/f1/submissions/upload
Copied!
1
SAMPLE RESPONSE
2
{
3
"id": "3um227kbkkdqmu",
4
"created_at": "2020-06-18T09:10:44.502Z",
5
"filehash": "685vw362ba/passport_3um227kb511qmu",
6
"filetype": "passport",
7
"fileFormat": "image/jpeg"
8
}
Copied!

Step 2. Upload Selfie image

  1. 1.
    Repeat Step 1 with type value of "selfie"
  2. 2.
    Copy "filehash" value from response object and store it for later use.
"filehash" value is required when submitting the form data in Step 3.

Step 3. Submit KYC formdata

  1. 1.
    Set "kyc_level" as "L1"
  2. 2.
    Set "photoid_res" as the filehash value received in Step 1.
  3. 3.
    Set "selfie_res" as the filehash value received in Step 2.
  4. 4.
    Fill in other required arguments as described below:
Request Type
Request URL
POST
https://api2.argos-solutions.io/f1/submissions
Request Headers
1
headers = {
2
'x-api-key' : "your_api_key",
3
'Content-Type' : "application/x-www-form-urlencoded"
4
}
Copied!
Request Body
1
{
2
'email': '[email protected]',
3
'first_name': 'John',
4
'middle_name': 'Avg',
5
'last_name': 'Doe',
6
'nationality': 'United States, USA',
7
'date_of_birth': '1980-10-10',
8
'gender': 'male',
9
'id_type': 'passport',
10
'kyc_level': 'L1',
11
'photoid_res': '686v3v91ba/passport_cemt81k51r2k6o',
12
'selfie_res': '686v3v91ba/selfie_ceoihsdwe1r234i',
13
'userid': '112'
14
}
Copied!
Response
1
SAMPLE RESPONSE
2
{
3
"date_of_birth": "1980-10-10",
4
"email": "[email protected]",
5
"first_name": "John",
6
"gender": "male",
7
"id_type": "passport",
8
"kyc_level": "L1",
9
"last_name": "Joe",
10
"middle_name": "Avg",
11
"nationality": "United States, USA",
12
"photoid_res": "686v3v91ba/passport_cemt81k51r2k6o",
13
"selfie_res": "686v3v91ba/passport_ceoihsdwe1r234i",
14
"userid": "112",
15
"id": "1ettd8kbkkm4om",
16
"created_at": "2020-06-18T09:17:16.024Z"
17
}
Copied!
Sample Code
cURL
1
curl --location --request POST 'https://api2.argos-solutions.io/f1/submissions' \
2
--header 'x-api-key: your_api_key' \
3
--header 'Content-Type: application/x-www-form-urlencoded' \
4
--data-urlencode '[email protected]' \
5
--data-urlencode 'first_name=John' \
6
--data-urlencode 'last_name=Joe' \
7
--data-urlencode 'nationality=United States, USA' \
8
--data-urlencode 'date_of_birth=1980-10-10' \
9
--data-urlencode 'gender=male' \
10
--data-urlencode 'id_type=governmentid' \
11
--data-urlencode 'kyc_level=L1' \
12
--data-urlencode 'photoid_res=686v3v91ba/passport_cemt81k51r2k6o' \
13
--data-urlencode 'selfie_res=686v3v91ba/passport_ceoihsdwe1r234i'
Copied!
Node.js - Request
1
var request = require('request');
2
var options = {
3
'method': 'POST',
4
'url': 'https://api2.argos-solutions.io/f1/submissions',
5
'headers': {
6
'x-api-key': 'your_api_key',
7
'Content-Type': 'application/x-www-form-urlencoded'
8
},
9
form: {
10
'email': '[email protected]',
11
'first_name': 'John',
12
'last_name': 'Joe',
13
'nationality': 'United States, USA',
14
'date_of_birth': '1980-10-10',
15
'gender': 'male',
16
'id_type': 'governmentid',
17
'kyc_level': 'L1',
18
'photoid_res': '686v3v91ba/passport_cemt81k51r2k6o',
19
'selfie_res': '686v3v91ba/passport_ceoihsdwe1r234i'
20
}
21
};
22
23
request(options, function (error, response) {
24
if (error) throw new Error(error);
25
console.log(response.body);
26
});
Copied!
Arguments
Argument
Description
Required
email
Must be a valid email address format
YES
first_name
First Name
YES
middle_name
Middle Name
NO
last_name
Last Name
YES
nationality
Nationality code in ISO3 or Argos format.
YES
date_of_birth
(YYYY-MM-DD) format
YES
gender
Gender &lt;male / female&gt;
YES
id_type
ID Type &lt;passport, drivers_license, government_id&gt;
YES
id_number
ID number or passport number
NO
kyc_level
KYC Level &lt;L1 / L2&gt;
YES
photoid_res
The hash id from the uploaded id image APIEg. 885vw362ba/passport_3um227kb511qmu
YES
selfie_res
The hash id from the uploaded selfie image APIEg. 885vw362ba/selfie_3um227skdlfilqmu
YES
userid
Unique custom ID (String) for each KYC applicant.
NO

KYC Level 2

KYC Level 2 verifies the customer’s address information in addition to KYC Level 1 ID and selfie identity verification. For KYC level 2 verification, you must first upload ID image and Selfie image, and address document image then includes their filehash in submission form data along with address information.

Step 1. Upload ID image

  1. 1.
    Upload an image with type value of "passport" "drivers_license" or "government_id".
  2. 2.
    Copy "filehash" value from response object and store it for later use. **This value is required when submitting the form data in Step 4.
Request Type
Request URL
POST
https://api2.argos-solutions.io/f1/submissions/upload
Request Headers
1
headers = {
2
'x-api-key' : "your_api_key",
3
'Content-Type' : 'multipart/form-data; boundary=<file_boundary>'
4
}
Copied!
Sample Code
Caution : If you would like to send a cURL POST request to API directly, image files need to be base64-encoded and boundary should be included in the headers.
cURL
1
curl --location --request POST 'https://api2.argos-solutions.io/f1/submissions/upload' \
2
--header 'x-api-key: <your_api_key_here>' \
3
--header ‘Content-Type’: “multipart/form-data; boundary= <file_boundary>’ \
4
--form '[email protected]/<your_file_path_here>' \
5
--form 'type=passport'
Copied!
Node.js - Request
1
var request = require('request');
2
var fs = require('fs');
3
var options = {
4
'method': 'POST',
5
'url': 'api2.argos-solutions.io/f1/submissions/upload',
6
'headers': {
7
'x-api-key': '<your_api_key_here>',
8
'Content-Type': 'multipart/form-data; boundary=<file_boundary>'
9
},
10
formData: {
11
'file': {
12
'value': fs.createReadStream('<your_file_path_here>'),
13
'options': {
14
'filename': '<file_name_here>',
15
'contentType': null
16
}
17
},
18
'type': 'passport'
19
}
20
};
21
22
request(options, function (error, response) {
23
if (error) throw new Error(error);
24
console.log(response.body);
25
});
Copied!
Arguments
Argument
Description
Required
file
The file which needs to be uploaded ( multipart form )
Yes
type
Possible document types: passport, drivers_license, government_id, selfie, address, other
Yes
"other" value in "type" refers to any additional image to store in Submission object (jpeg, png, pdf).
Response Object
Parameter
Description
Format
id
Document ID
text
created_at
Created date time
ISO8601
filehash
The file hash id that has been uploaded to Argos system when you submit the form data, this value used for photoid_res, selfie_res, address_res fields
text
filetype
Possible document types: &lt;passport, drivers_license, government_id, selfie, address&gt;
text
Example curl -H "x-api-key:hTRgZTc6UR2FLgIh5tKLsyjO89xBsiWG3pz3eYvc" -F "type=passport" -F "[email protected];type=image/png" https://api2.argos-solutions.io/f1/submissions/upload
1
SAMPLE RESPONSE
2
{
3
"id": "3um227kbkkdqmu",
4
"created_at": "2020-06-18T09:10:44.502Z",
5
"filehash": "685vw362ba/passport_3um227kb511qmu",
6
"filetype": "passport",
7
"fileFormat": "image/jpeg"
8
}
Copied!

Step 2. Upload Selfie image

  1. 1.
    Repeat Step 1 with type value of “selfie”
  2. 2.
    Copy “filehash” value from response object and store it for later use.
”filehash” value is required when submitting the form data in Step 4.

Step 3. Upload address document image

  1. 1.
    Repeat Step 1 with type value of “address”
  2. 2.
    Copy “filehash” value from response object and store it for later use. **This value is required when submitting the form data in Step 4.

Step 4. Submit KYC formdata

  1. 1.
    Set “kyc_level” as “L2”
  2. 2.
    Set “photoid_res” as the filehash value received in Step 1.
  3. 3.
    Set “selfie_res” as the filehash value received in Step 2.
  4. 4.
    Set “address_res” as the file has value received in Step 3.
  5. 5.
    Fill in other required arguments as described below:
Request Type
Request URL
POST
https://api2.argos-solutions.io/f1/submissions
Request Headers
1
headers = {
2
'x-api-key' : "your_api_key",
3
'Content-Type' : "application/x-www-form-urlencoded"
4
}
Copied!
Request Body
Sample Request Body
1
{
2
'email': '[email protected]',
3
'first_name': 'John',
4
'middle_name': 'Avg',
5
'last_name': 'Doe',
6
'nationality': 'United States, USA',
7
'date_of_birth': '1980-10-10',
8
'gender': 'male',
9
'id_type': 'passport',
10
'kyc_level': 'L1',
11
'photoid_res': '686v3v91ba/passport_cemt81k51r2k6o',
12
'selfie_res': '686v3v91ba/selfie_ceoihsdwe1r234i',
13
'address_res': '686v3v91ba/address_hrtytyhsdw19c234i',
14
'userid': '112',
15
'address_street': '5000 Forbes Ave',
16
'address_city': 'Pittsburgh',
17
'address_state': 'PA',
18
'address_zipcode': '15213',
19
'address_country': 'United States, USA'
20
}
Copied!
Response
1
SAMPLE RESPONSE
2
{
3
"address_city": "Pittsburgh",
4
"address_country": "United States, USA",
5
"address_res": "686v3v91ba/address_hrtytyhsdw19c234i",
6
"address_state": "PA",
7
"address_street": "5000 Forbes Ave",
8
"address_zipcode": "15213",
9
"date_of_birth": "1980-10-10",
10
"email": "[email protected]",
11
"first_name": "John",
12
"gender": "male",
13
"id_type": "passport",
14
"kyc_level": "L1",
15
"last_name": "Joe",
16
"middle_name": "Avg",
17
"nationality": "United States, USA",
18
"photoid_res": "686v3v91ba/passport_cemt81k51r2k6o",
19
"selfie_res": "686v3v91ba/passport_ceoihsdwe1r234i",
20
"userid": "112",
21
"id": "1ettd8kbkkm4om",
22
"created_at": "2020-06-18T09:17:16.024Z"
23
}
Copied!
Sample Code cURL
1
curl --location --request POST 'https://api2.argos-solutions.io/f1/submissions' \
2
--header 'x-api-key: your_api_key' \
3
--header 'Content-Type: application/x-www-form-urlencoded' \
4
--data-urlencode 'address_street=5000 Forbes Ave' \
5
--data-urlencode 'address_city=Pittsburgh' \
6
--data-urlencode 'address_state=PA' \
7
--data-urlencode 'address_zipcode=15213' \
8
--data-urlencode 'address_country=United States, USA' \
9
--data-urlencode '[email protected]' \
10
--data-urlencode 'first_name=John' \
11
--data-urlencode 'last_name=Joe' \
12
--data-urlencode 'nationality=United States, USA' \
13
--data-urlencode 'date_of_birth=1980-10-10' \
14
--data-urlencode 'gender=male' \
15
--data-urlencode 'id_type=governmentid' \
16
--data-urlencode 'kyc_level=L1' \
17
--data-urlencode 'photoid_res=686v3v91ba/passport_cemt81k51r2k6o' \
18
--data-urlencode 'selfie_res=686v3v91ba/passport_ceoihsdwe1r234i' \
19
--data-urlencode 'address_res=686v3v91ba/address_hrtytyhsdw19c234i'
Copied!
Node.js - Request
1
var request = require('request');
2
var options = {
3
'method': 'POST',
4
'url': 'https://api2.argos-solutions.io/f1/submissions',
5
'headers': {
6
'x-api-key': 'your_api_key',
7
'Content-Type': 'application/x-www-form-urlencoded'
8
},
9
form: {
10
'email': '[email protected]',
11
'first_name': 'John',
12
'last_name': 'Joe',
13
'nationality': 'United States, USA',
14
'date_of_birth': '1980-10-10',
15
'gender': 'male',
16
'id_type': 'governmentid',
17
'kyc_level': 'L1',
18
'photoid_res': '686v3v91ba/passport_cemt81k51r2k6o',
19
'selfie_res': '686v3v91ba/passport_ceoihsdwe1r234i',
20
'address_res': '686v3v91ba/address_hrtytyhsdw19c234i',
21
'address_street': '5000 Forbes Ave',
22
'address_city': 'Pittsburgh',
23
'address_state': 'PA',
24
'address_zipcode': '15213',
25
'address_country': 'United States, USA'
26
}
27
};
28
29
request(options, function (error, response) {
30
if (error) throw new Error(error);
31
console.log(response.body);
32
});
Copied!
Arguments
Argument
Description
Required
email
Must be a valid email address format
YES
first_name
First Name
YES
middle_name
Middle Name
NO
last_name
Last Name
YES
nationality
Nationality code in ISO3 or Argos format.
YES
date_of_birth
(YYYY-MM-DD) format
YES
gender
Gender (male/female)
YES
id_type
ID Type (passport / government_id)
YES
id_number
ID number or passport number
NO
kyc_level
KYC Level (L1 / L2)
YES
photoid_res
The hash id from the uploaded id image API ex) 885vw362ba/passport_3um227kb511qmu
YES
selfie_res
The hash id from the uploaded selfie image API ex) 885vw362ba/selfie_3um227skdlfilqmu
YES
userid
Unique ID (String) for each KYC applicant.
NO
address_street
Address - Street
YES
address_city
Address - City
YES
address_state
Address - State
YES
address_zipcode
Address - Zip(postal) Code
YES
address_country
Address - Country
YES
address_res
The hash id from the uploaded proof of residence image API ex) shz28vkee7/address_4e2koq1jn04vtms
YES

Additional Arguments (Optional)

In case you want to pass in additional information when submitting the KYC, you can use below arguments. Any other unrecognized arguments will be ignored.
Arguments
Argument
Description
userid
Unique ID for each KYC applicant.
id_number
Unique ID number issued on Photo ID (ex. Passport number)
contribution_type
Currency type (ex. USD, KRW, BTC, ETH…)
estimated_amount
Estimated investment amount
wallet_address
Cryptocurrency wallet address.If a wallet address is submitted, the wallet address is checked against the cryptocurrency blacklist for Crypto AML Screening.
wallet_address1
Additional wallet address for Crypto AML Screening.
wallet_address2
Additional wallet address for Crypto AML Screening.
wallet_address3
Additional wallet address for Crypto AML Screening.
image_res1
Any additional image to store in Submission object (jpeg, png, pdf). Enter "other" for type when uploading image.
image_res2
Any additional image to store in Submission object (jpeg, png, pdf) Enter "other" for type when uploading image.
image_res3
Any additional image to store in Submission object (jpeg, png, pdf) Enter "other" for type when uploading image.
image_res4
Any additional image to store in Submission object (jpeg, png, pdf) Enter "other" for type when uploading image.
cf1
Any additional information to store in Submission object (String)
cf2
Any additional information to store in Submission object (String)
cf3
Any additional information to store in Submission object (String)
ip_address
IP Address V4 format (ex. 123.123.123.123). This IP address is used to find the IP location of the user.

Webhook

Webhook provides real-time notifications when specific events occur.

Webhook Integration

To integrate webhook, please send your webhook URL to your Argos Representative.

Webhook Triggers

"Submission data" only returns entered information. In cases when you do not include any optional information such as "cf1" or "wallet_address" in submission data, the response object does not include them either.

Trigger 1: When a KYC submission is made

KYC submission data is returned when the KYC submission process is complete.
Parameter
Description
email
Email address
created_at
Time when a KYC submission is complete
webhook_trigger
submit
submission_id
Submission ID
userid
Unique ID for each KYC applicant (≠ submission id)
1
SAMPLE RESPONSE
2
{
3
"email":"[email protected]",
4
"created_at":"2020-08-27T11:47:17.345Z",
5
"webhook_trigger":"submit",
6
"submission_id":"1jrho7kecqsonc"
7
}
Copied!

Trigger 2: When a KYC application is rejected

KYC submission data is returned when KYC is rejected.
Parameter
Description
kyc_result
KYC result
status
rejected
comment
Detailed reason of KYC rejection
updated_at
Time when KYC is rejected
email
Email address
webhook_trigger
rejected
submission_id
Submission ID
userid
Unique ID for each KYC applicant (≠ submission id)
1
SAMPLE RESPONSE
2
{
3
"kyc_result": {
4
"status": "rejected",
5
"comment": "The entered information does not match with your ID document.",
6
"updated_at": "2020-06-02T05:19:49.685Z"
7
},
8
"email": "[email protected]",
9
"webhook_trigger": "rejected",
10
"submission_id": "35sl57karv614s"
11
}
Copied!

Trigger 3: When a KYC application is approved

KYC submission data is returned when KYC is approved.
Parameter
Description
kyc_result
KYC result
status
approved
updated_at
Time when KYC is approved
email
Email address
webhook_trigger
approved
submission_id
Submission ID
userid
Unique ID for each KYC applicant (≠ submission id)
1
SAMPLE RESPONSE
2
{
3
"kyc_result":{
4
"status":"approved",
5
"updated_at":"2020-08-27 21:51"
6
},
7
"webhook_trigger":"approved",
8
"email":"[email protected]",
9
"submission_id":"1jrho7kecqsonc"
10
}
Copied!

Trigger 4: When AML screening is complete

AML result and submission data are returned when AML screening is complete.
Parameter
Description
aml_result
AML screening result
currentstatus
Not Screened: no match found in AML database Red Flag : Search result matched with match found in AML database
risk_level_summary
(Not Screened, High, Medium, Low)
webhook_trigger
aml
submission_id
Submission ID
userid
Unique ID for each KYC applicant (≠ submission id)
Sample Response 1: Red Flag
1
{
2
"aml_result":{
3
"currentstatus":"Red Flag",
4
"risk_level_summary":"HIGH"
5
},
6
"webhook_trigger":"aml",
7
"email":"[email protected]",
8
"submission_id":"22d4r08kedv2m4d"
9
}
Copied!
Sample Response 2: Not Screened
1
SAMPLE RESPONSE
2
{
3
"aml_result":{
4
"currentstatus":"Not Screened",
5
"risk_level_summary":"Not Screened"
6
},
7
"webhook_trigger":"aml",
8
"email":"[email protected]",
9
"submission_id":"1jrho7alsdksonc"
10
}
Copied!
Last modified 2mo ago