Get/Submission
GET requests allows querying details of KYB data(including AML) and list of submissions.
Use 'submission_id' parameter to get a specific submission data. If it's requested with no 'submission_id', it will return multiple submission data as default, maximum 100 submissions.
'submission_id' is unique verifying ID for each submissions.
Input Data
This part will explain the required parameters needed when querying the data.
Refer to 'Inquire for one submission data' section to call single submission data
Refer to 'Inquire for multiple submission data' section to call multiple submission data
submission_id
optional
Unique verifying code for each submissions.
count
optional
Number of submission data to get, default is the maximum number: 100.
start_date
optional
Start date (YYYY-MM-DD)
end_date
optional
End date (YYYY-MM-DD)
nextpage_id
optional
If you get 'nextpageKey' in response, it means there is a next page. To call the next page, call with 'nextpage_id(nextpageKey.id)' and 'nextpage_date(nextpageKey.created_at)'.
nextpage_date
optional
If you get 'nextpageKey' in response, it means there is a next page. To call the next page, call with 'nextpage_id(nextpageKey.id)' and 'nextpage_date(nextpageKey.created_at)'.
Output Data
'representative' object contains KYB submitter's personal info, type and submission status.
'AML' object contains the AML result of the corporate.
'directors' object contains directors' personal info and AML results.
'shareholders' object contains the shareholders(UBOs)' personal info and aml results.
'note' objects contains memos on progress.
projectId
Unique ID of the project
submissionId
Unique ID of the submission
company_name
Name of the entity
company_id
Company ID selectively given to the target corporate by client.
created_at
Start date of submission (UTC+0)
updated_at
Update date of submission (UTC+0)
kyb_status
KYB Status {Open, Complete, Closed}
- Open: Documents are being collected or inspected
- Complete: KYB completed
- Closed: Suspended due to no response from the entity
aml_screen
AML result of the entity {Red Flag, Not Screened}
nationality
Jurisdiction of the entity
address
Address of the entity
representative
Data object of the representative
representative.nationality
Nationality of the representative
representative.name
Name of the representative
representative.status
Status of the the representative {Open / Complete}
- Open: Documentations required for identification is being collected or reviewed
- Complete: Documentations are all collected and reviewed
representative.represent_type
Type of the representative(null, ceo, delegate)
- null: Undefined
- ceo: CEO
- delegate: Representative of the corporate
representative.date_of_birth
Birthdate of the representative
representative.ceo_name
Name of the CEO
AML
Data object of AML result of the entity
AML.matches
Data object of AML matching result
AML.matches.score
Similarity score with the matched company
AML.matches.resource_id
Unique ID of the matched company
AML.match_count
AML matching count
aml_result
Data object of AML result of the entity
aml_result.risk_level
Risk level of the matched entity {HIGH, MEDIUM, LOW}
aml_risk_level_summary
Overall risk level of the entity
directors
Data object of director
directors.name
Name of director
directors.status
Status of the the director info {Open, Complete}
- Open: Documentations required for identification is being collected or reviewed
- Complete: Documentations are all collected and reviewed
directors.date_of_birth
Birthdate of director
directors.nationality
Nationality of director
directors.created_at
Start date of submission on director info (UTC+0)
directors.updated_at
Update date of submission on director info (UTC+0)
directors.AML
Data object of director's AML result
directors.AML.matches
Data object of director's matching result
directors.AML.matches.score
Similarity score with the matched person
directors.AML.matches.resourceId
Unique ID of the matched person
directors.AML.match_count
AML matching count of director
directors.aml_result
Data object of director's AML result
directors.aml_update_time
Update time of director's AML result
directors.aml_screen
AML result of the director {Red Flag, Not Screened}
directors.aml_result.risk_level
Risk level of the matched person {HIGH, MEDIUM, LOW}
directors.aml_risk_level_summary
Overall risk level of the director
shareholders
Data object of shareholder
shareholders.name
Name of shareholder
shareholders.status
Status of the the shareholder info {Open, Complete}
- Open: Documentations required for identification is being collected or reviewed
- Complete: Documentations are all collected and reviewed
shareholders.type
Type of shareholder {Individual, Corporate}
shareholders.nationality
Nationality of shareholder
shareholders.ratio
Shareholding %
shareholders.date_of_birth
Birthdate of shareholder
shareholders.created_at
Start date of submission on shareholder info (UTC+0)
shareholders.updated_at
Update date of submission on shareholder info (UTC+0)
shareholders.parent
Parent company of the shareholder
“ “ : When the company owns itself
UBOName: When there is a parent company
shareholders.level
Layer of ownership
shareholders.aml_screen
AML result of shareholder
{Red Flag, Not Screened}
shareholders.AML
Data object of shareholder's AML result
shareholders.AML.matches
Data object of shareholder's matching result
shareholders.AML.matches.score
Similarity score with the matched person
shareholders.AML.matches.resourceId
Unique ID of the matched person
shareholders.AML.match_count
AML matching count
shareholders.aml_result
Data object of shareholder's AML result
shareholders.aml_result.risk_level
Risk level of the matched person {HIGH, MEDIUM, LOW}
note
Data object of KYB memo
note.title
Title of memo
note.text
Text of memo
note.user
Email of memo writter
note.update_at
Update time of memo
aml_final_status
Final AML result of KYB submission {Red Flag, Not Screened}
aml_final_update_time
Update date of final AML result (UTC+0)
nextpageKey
'Key' value object for next page
nextpageKey.id
The most recent inquired submission ID which is needed to call the next page
nextpageKey.created_at
Create time of the most recent inquired submission ID which is needed to call the next page (UTC + 0)
Sample
Inquire for one submission data
Sample Request
Sample request to query one submission data.
Should be called with 'Qeury Params' and URL, x-api-key required.
Only one can be inquired.
Sample Response
Sample response of submission data.
KYB data such as CEO and representative's personal info, director info, shareholder info and AML results will be responsed.
Inquire for multiple submission data
Sample Request
Sample request to query multiple submission data.
Should be called with 'Qeury Params' and URL, x-api-key required.
It will return the whole list of submission data.
Sample Response
Sample response of submission data.
KYB data such as CEO and representative's personal info, director info, shareholder info and AML results will be responsed.
Last updated