跳至主要内容
API docs by Redocly

Compliance KYABC API (0.1.0)

Download OpenAPI specification:Download

KYC risk rating is formed based on customer data collected by financial institutions.

KryptoGO Compliance evaluates each customer's possible involvement in financial crimes, based on customer risk (sanctions list screening, company-related information, political figures, terrorist lists, court decisions, negative news scan results, etc.), calculate a risk score. This risk score will correspond to a KYC risk rating. According to the level of risk, there are 5 standard types of KYC risk ratings.

  • Low risk (0-24 points)
  • Low to medium risk (25-49 points)
  • Medium risk (50-74 points)
  • High risk (75-99 points)
  • Very high risk (100 points)

The KYC risk rating ensures compliance with global regulations such as AML, KYC, and CTF/CFT standards. To determine whether the risk factor is really relevant to the customer based on the customer’s personally identifiable information, and conduct EDD (enhanced due diligence) to ask the customer to submit other documents, such as the source of income, confirmation of registered address, etc.

In order to protect your own company from corruption and money laundering, it is extremely important to implement a KYC risk assessment for all customers-this is the most reliable way to determine which customers are riskier to your company and thus avoid liability.

KYC risk ratings can be formed manually or automatically. Although the results cannot be absolutely accurate anyway, large companies with large amounts of information need automation. At KryptoGO, our advanced technology provides each customer with a KYC risk rating, the results are as accurate as possible, and users can be manually rechecked, and our CAMS anti-money laundering specialist can even assist you in risk assessment.

DD - KYA

Identify the risk of blockchain address

Get blockchain address risk analysis task detail

Get KYA task detail by an unique KYA id

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
Example: 12

Responses

Response samples

Content type
application/json
{
  • "kya_id": 12,
  • "address": "0x72a5843cc08275c8171e582972aa4fda8c397b2a",
  • "data": {
    },
  • "sdnlist": [
    ],
  • "txlist": [
    ],
  • "creation_timestamp": 1698661028,
  • "creator_account": "eric.hung@kryptogo.com",
  • "creator_email": "eric.hung@kryptogo.com",
  • "creator_name": "Eric Hung",
  • "customer_reference": null
}

Create blockchain address risk analysis task

Create KYA task which belong to the owner of API token (only supports BTC/ETH for now).

This API will return the latest kya result along with kya_id in the response. You can get the same kya result later by calling GET /kya/detail/{kya_id}.

To access task detail with KryptoGO Compliance website, please use the following URL: https://app.kryptogo.com/compliance/addresses/{kya_id}

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

The address to analyze

address
required
string

The blockchain address to analyze

chain
string

The blockchain symbol of the address. If not specified, the API will try to detect the chain from the address.

Responses

Request samples

Content type
application/json
{
  • "address": "0x72a5843cc08275C8171E582972Aa4fDa8C397B2A",
  • "chain": "eth"
}

Response samples

Content type
application/json
{
  • "kya_id": 12,
  • "address": "0x72a5843cc08275c8171e582972aa4fda8c397b2a",
  • "data": {
    },
  • "sdnlist": [
    ],
  • "txlist": [
    ],
  • "creation_timestamp": 1698661028,
  • "creator_account": "eric.hung@kryptogo.com",
  • "creator_email": "eric.hung@kryptogo.com",
  • "creator_name": "Eric Hung",
  • "customer_reference": null
}

DD - KYB & KYC

Create and manage due diligence tasks for individuals and business

Get summary of a search task

Retrieve summary information about a specific search task using its unique task ID.

To access task detail with KryptoGO Compliance website, please use the following URL: https://app.kryptogo.com/compliance/audit/{task_id}

Authorizations:
ApiKeyAuth
path Parameters
task_id
required
string
Example: 120

Responses

Response samples

Content type
application/json
{
  • "task_id": 123,
  • "search_setting": {
    },
  • "target": {
    },
  • "customer_reference": "000000123",
  • "progress": 100,
  • "task_origin": 1,
  • "creation_time": 1623859200,
  • "update_time": 1623867890,
  • "audit_time": 1623859200,
  • "report": {},
  • "metadata": [
    ],
  • "associated_with_a_idv_task": true,
  • "associated_idv_id": [
    ]
}

Get details of a search task

Retrieve detailed information about a specific search task using its unique task ID.

To access task detail with KryptoGO Compliance website, please use the following URL: https://app.kryptogo.com/compliance/audit/{task_id}

Authorizations:
ApiKeyAuth
path Parameters
task_id
required
string
Example: 123

Responses

Response samples

Content type
application/json
{
  • "task_id": 12345,
  • "target": {
    },
  • "search_setting": {
    },
  • "search_source": [
    ],
  • "callback_url": "string",
  • "customer_reference": "string",
  • "result": {
    },
  • "sanction_matched": true,
  • "completed_source": 3,
  • "potential_risk": 51,
  • "url": "https://app.kryptogo.com/compliance/audit/123",
  • "audit_status": 0,
  • "comment": "",
  • "audit_time": 0,
  • "auditor_employee_id": 321,
  • "auditor_employee_name": "Auditor Krypto",
  • "auditor_employee_account": "auditor@kryptogo.com",
  • "employee_id": 123,
  • "employee_name": "Eric Hung",
  • "employee_account": "eric@kryptogo.com",
  • "creation_time": 1700470381,
  • "update_time": 1700470389,
  • "completed_time": 1700470389,
  • "from_idv_id": 0,
  • "comment_time": null,
  • "comment_employee_id": null,
  • "comment_employee_name": null,
  • "comment_employee_account": null,
  • "metadata": {
    },
  • "comment_logs": [
    ],
  • "aml_summarization": "string",
  • "next_review_at": 1716345869
}

Create search tasks

Create DD tasks which belong to the owner of API token. Different target attribute should be specified when the search type is KYB or KYC. The callback URL will be called when:

  • The task is completed (i.e. the search results are generated)
  • The task's accepted status is changed (refer to [POST] /task/{task_id}/accepted)
Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

The search task to create

Array
search_setting_id
required
integer

The ID of search setting to use.

You can modify your search setting here. To know the ID of the search setting, check the url in the setting detail page. E.g., https://app.kryptogo.com/compliance/settings/search-settings/detail/2. Then the ID is 2.

required
SearchTaskKycTarget (object) or SearchTaskKybTarget (object)
search_source
required
Array of arrays (SearchSource)

The array of source to search (Default is searching all):

  • 0: Negative news
  • 1: Dow Jones database
  • 2: Taiwan company
  • 3: Taiwan verdict
  • 4: Sanction list
callback_url
string <uri>

The URL which will be called when the task is completed, or the task's accepted status is changed

customer_reference
string

The internal customer reference of your system

from_idv_id
integer

ID of certain IDV task, indicates the source of this search task. If from_idv_id is presented, the following data are forced copy from the IDV task: target.birthday, target.citizenship, customer_reference and callback_url.

Responses

Callbacks

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Callback payload samples

Callback
POST: Search task status callback
Content type
application/json
{
  • "task_id": 123,
  • "search_setting": {
    },
  • "target": {
    },
  • "customer_reference": "000000123",
  • "progress": 100,
  • "task_origin": 1,
  • "creation_time": 1623859200,
  • "update_time": 1623867890,
  • "audit_time": 1623859200,
  • "report": {},
  • "metadata": [
    ],
  • "associated_with_a_idv_task": true,
  • "associated_idv_id": [
    ]
}

Update a search task's accepted status

When the search task has been already accepted/rejected, the comment and accepted fields of this search task can't be changed, and the server will return 409 error.

Upon successful accepted status update, the callback URL of this task will be called.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

The search task information to update

comment
required
string

The comment of the search task report (usually the reason of accepting/rejecting this target)

accepted
required
boolean

Whether to accept the target of this search task

Responses

Request samples

Content type
application/json
{
  • "comment": "The negative news are not related to the target",
  • "accepted": true
}

Response samples

Content type
application/json
{
  • "task_id": 123,
  • "comment": "The negative news are not related to the target",
  • "accepted": true
}

Set metadata to the search task

Allow custom metadata of a key-value pair object array to append to the search task.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

The key-value pair object array

Array
key
string

The key(name) of the metadata

value
string

The value of the metadata

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0
}

Get search task history

Get search task history of a given customer

Authorizations:
ApiKeyAuth
query Parameters
page_size
required
integer
Example: page_size=10

The size of a page to return

page_number
required
integer
Example: page_number=1

The page number (starting from 1) to return

customer_reference
string
Example: customer_reference=000000123

The internal customer reference of your system

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

ID Verification

Create and manage ID verification tasks for individual's ID upload

Get IDV task summary

Get IDV task summary by an unique IDV id. This endpoint is designed for polling the IDV task states.

It's highly recommended to use this API when you want to check the states of the IDV task. E.g., when you want to check the IDV task is completed or not.

To access task detail with KryptoGO Compliance website, visit the following URL: https://app.kryptogo.com/compliance/idv/{idv_id}

Authorizations:
ApiKeyAuth
path Parameters
idv_id
required
string
Example: 12

Responses

Response samples

Content type
application/json
{
  • "idv_task_id": 12,
  • "state": 0,
  • "audit_status": "Accepted",
  • "audit_timestamp": 1641982000,
  • "auditor_employee_account": "admin",
  • "auditor_employee_name": "Admin",
  • "creation_timestamp": 1623859200,
  • "state_timestamp": 1623867890,
  • "review_reasons": [
    ],
  • "reject_reasons": [
    ]
}

Get IDV task detail

Get IDV task detail by an unique IDV id.

In most cases you only need /idv/{idv_id}/summary, but if you need more detailed information, use this endpoint instead.

To access task detail with KryptoGO Compliance website, visit the following URL: https://app.kryptogo.com/compliance/idv/{idv_id}

Authorizations:
ApiKeyAuth
path Parameters
idv_id
required
string
Example: 12

Responses

Response samples

Content type
application/json
{
  • "idv_task_id": 12,
  • "country": "TWN",
  • "id_type": "ID_CARD",
  • "id_sub_type": "NATIONAL_ID",
  • "id_image_url": "https://static.kryptogo.com/id-image.jpg",
  • "id_back_image_url": "https://static.kryptogo.com/id-back-image.jpg",
  • "face_image_url": "https://static.kryptogo.com/face-image.jpg",
  • "id_and_face_image_url": "https://static.kryptogo.com/id-face-image.jpg",
  • "expected_name": "王又曾",
  • "expected_birthday": "1990-06-21",
  • "expected_id_number": "A123456789",
  • "expected_country": "TWN",
  • "expected_issuing_date": "2020-03-10",
  • "expected_expiry_date": "2025-03-10",
  • "expected_gender": "M",
  • "customer_reference": "000000123",
  • "first_name": "又曾",
  • "last_name": "王",
  • "full_name": "王又曾",
  • "birthday": "1965-03-16",
  • "id_number": "A223456789",
  • "issuing_date": "2020-03-10",
  • "expiry_date": "2025-03-10",
  • "gender": "M",
  • "state": 0,
  • "review_reasons": [
    ],
  • "reject_reasons": [
    ],
  • "created_search_task_id": 102,
  • "audit_status": "Accepted",
  • "audit_timestamp": 1641982000,
  • "auditor_employee_account": "admin",
  • "auditor_employee_name": "Admin",
  • "dd_tasks": [
    ]
}

Create an IDV task

Create an IDV task by uploading ID image and selfie face photo (selfie face photo can be replaced with photo of the person holding ID document). A DD search task can be created automatically from the recognized information in images.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

The body of the idv task API request

country
required
string

The country of the ID. Should be ISO-3166 Alpha-3

id_type
required
string

The type of ID. Supports PASSPORT, DRIVING_LICENSE and ID_CARD

id_image
required
string

The base64 encoding of ID image (front side). Max. 15MB & <8000 pixels per side & longest side >300 pixels

id_mime_type
string

Mime type of ID image. Can be image/jpeg(default) or image/png

id_back_image
string

The base64 encoding of ID image (back side). Required when id_type is ID_CARD. Max. 15MB & <8000 pixels per side & longest side >300 pixels

id_back_mime_type
string

Mime type of ID image back side. Can be image/jpeg(default) or image/png

face_image
required
string

The base64 encoding of face image. At least one of face_image or id_and_face_image should be provided. Max. 15MB & <8000 pixels per side & longest side >300 pixels

face_mime_type
string

Mime type of face image. Can be image/jpeg(default) or image/png

id_and_face_image
required
string

The base64 encoding of image of the person holding ID document. At least one of face_image or id_and_face_image should be provided.

id_and_face_mime_type
string

Mime type of image of the person holding ID document. Can be image/jpeg(default) or image/png

expected_name
string

The expected full name of the ID holder. If it doesn't match the recognized name on the ID, the result state will be review

expected_birthday
string

The expected birthday of the ID holder in YYYY-MM-DD format. If it doesn't match the recognized birthday on the ID, the result state will be review

expected_id_number
string

The expected ID number of the ID holder. If it doesn't match the recognized ID number on the ID, the result state will be review

expected_issuing_date
string

The expected issuing Date of the ID holder. If it doesn't match the recognized ID number on the ID, the result state will be review

expected_expiry_date
string

The expected expiry Date of the ID holder. If it doesn't match the recognized ID number on the ID, the result state will be review

expected_gender
string

The expected gender of the ID holder. If it doesn't match the recognized ID number on the ID, the result state will be review

callback_url
string <uri>

The URL which will be called when the IDV task is completed

customer_reference
string

The internal customer reference of your system

auto_create_dd_task
boolean

Whether to automatically create DD search task for the target if the result state is accept (default is false). If the result state is review or reject, the DD search task won't be created even this field is true

dd_task_callback_url
string

The callback URL to use if a DD search task is created from this IDV task

dd_task_search_setting_id
integer

The ID of search setting to use if a DD search task is created from this IDV task.

Required when a DD search task is created.

You can modify your search setting here. To know the ID of the search setting, check the url in the setting detail page. E.g., https://app.kryptogo.com/compliance/settings/search-settings/detail/2. Then the ID is 2.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "country": "TWN",
  • "id_type": "ID_CARD",
  • "id_image": "iVBORw0KGgoAAA...",
  • "id_mime_type": "image/jpeg",
  • "id_back_image": "iVBORw0KGgoAAA...",
  • "id_back_mime_type": "image/jpeg",
  • "face_image": "iVBORw0KGgoAAA...",
  • "face_mime_type": "image/jpeg",
  • "id_and_face_image": "iVBORw0KGgoAAA...",
  • "id_and_face_mime_type": "image/jpeg",
  • "expected_name": "王又曾",
  • "expected_birthday": "1990-06-21",
  • "expected_id_number": "A123456789",
  • "expected_issuing_date": "2020-03-10",
  • "expected_expiry_date": "2025-03-10",
  • "expected_gender": "M",
  • "callback_url": "https://myserver.com/send/callback/here",
  • "customer_reference": "000000123",
  • "auto_create_dd_task": true,
  • "dd_task_callback_url": "https://myserver.com/send/callback/here",
  • "dd_task_search_setting_id": 120
}

Response samples

Content type
application/json
{
  • "idv_task_id": 12,
  • "timestamp": 1623859200
}

Callback payload samples

Callback
POST: IDV task result callback
Content type
application/json
{
  • "idv_task_id": 12,
  • "country": "TWN",
  • "id_type": "ID_CARD",
  • "id_sub_type": "NATIONAL_ID",
  • "id_image_url": "https://static.kryptogo.com/id-image.jpg",
  • "id_back_image_url": "https://static.kryptogo.com/id-back-image.jpg",
  • "face_image_url": "https://static.kryptogo.com/face-image.jpg",
  • "id_and_face_image_url": "https://static.kryptogo.com/id-face-image.jpg",
  • "expected_name": "王又曾",
  • "expected_birthday": "1990-06-21",
  • "expected_id_number": "A123456789",
  • "expected_country": "TWN",
  • "expected_issuing_date": "2020-03-10",
  • "expected_expiry_date": "2025-03-10",
  • "expected_gender": "M",
  • "customer_reference": "000000123",
  • "first_name": "又曾",
  • "last_name": "王",
  • "full_name": "王又曾",
  • "birthday": "1965-03-16",
  • "id_number": "A223456789",
  • "issuing_date": "2020-03-10",
  • "expiry_date": "2025-03-10",
  • "gender": "M",
  • "state": 0,
  • "review_reasons": [
    ],
  • "reject_reasons": [
    ],
  • "created_search_task_id": 102,
  • "audit_status": "Accepted",
  • "audit_timestamp": 1641982000,
  • "auditor_employee_account": "admin",
  • "auditor_employee_name": "Admin",
  • "dd_tasks": [
    ]
}

Initiating an IDV transaction for Web Verification

Call the RESTful API POST endpoint /idv/init with a JSON object containing the properties described below to create a transaction for each user. You will receive a JSON object in the response containing timestamp, idv_task_id and a URL which you can use to present ID Verification to your user.

There must be more than 500 points remaining to perform this operation. Points will be deducted after the user successfully uploads the verification information.

A DD search task can be created automatically from the recognized information in images.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

The body of the web initiate API request.

Please select one of the following request schema according to your current idv engine (Jumio or Sumsub).

One of
id_type
required
string

The type of ID. Supports PASSPORT, DRIVING_LICENSE and ID_CARD

workflow_id
required
integer

Applies this acquisition workflow to the transaction. Supported workflowId values:

  • 100 ID only, camera + upload
  • 101 ID only, camera only
  • 102 ID only, upload only
  • 200 ID + Identity, camera + upload
  • 201 ID + Identity, camera only
  • 202 ID + Identity, upload only
country
required
string

The country of the ID. Should be ISO-3166 Alpha-3

customer_reference
required
string

The internal customer reference of your system. Max length is 100

locale
string

Renders web page in the specified language. Supported locale values:

  • ar Arabic
  • bg Bulgarian
  • cs Czech
  • da Danish
  • de German
  • el Greek
  • en American English (default)
  • en-GB British English
  • es Spanish
  • es-MX Mexican Spanish
  • et Estonian
  • fi Finnish
  • fr French
  • he Hebrew
  • hr Croatian
  • hu Hungarian
  • hy Armenian
  • id Indonesian
  • it Italian
  • ja Japanese
  • ka Georgian
  • km Khmer
  • ko Korean
  • lt Lithuanian
  • ms Malay
  • nl Dutch
  • no Norwegian
  • pl Polish
  • pt Portuguese
  • pt-BR Brazilian Portuguese
  • ro Romanian
  • ru Russian
  • sk Slovak
  • sv Swedish
  • sw Swahili
  • th Thai
  • tr Turkish
  • vi Vietnamese
  • zh-CN Simplified Chinese
  • zh-HK Traditional Chinese
success_url
string

Redirects to this URL after a successful transaction. Max length is 2047

error_url
string

Redirects to this URL after an unsuccessful transaction. Max length is 255

expected_name
string

The expected full name of the ID holder. If it doesn't match the recognized name on the ID, the result state will be review

expected_birthday
string

The expected birthday of the ID holder in YYYY-MM-DD format. If it doesn't match the recognized birthday on the ID, the result state will be review

expected_id_number
string

The expected ID number of the ID holder. If it doesn't match the recognized ID number on the ID, the result state will be review

callback_url
string <uri>

The URL which will be called when the IDV task is completed

auto_create_dd_task
boolean

Whether to automatically create DD search task for the target if the result state is accept (default is false). If the result state is review or reject, the DD search task won't be created even this field is true

dd_task_callback_url
string

The callback URL to use if a DD search task is created from this IDV task

dd_task_search_setting_id
integer

The ID of search setting to use if a DD search task is created from this IDV task.

Required when a DD search task is created.

You can modify your search setting here. To know the ID of the search setting, check the url in the setting detail page. E.g., https://app.kryptogo.com/compliance/settings/search-settings/detail/2. Then the ID is 2.

tw_id_apply_code
integer

(Support when id_type = ID_CARD and country = TWN) Not Issue = 0, Initial Issue = 1, Reissue = 2, Change = 3

tw_id_apply_date
string

(Support when id_type = ID_CARD and country = TWN) Issuing date, Republic of China (ROC) format, 7 digits.

tw_id_issue_site_id
string

(Support when id_type = ID_CARD and country = TWN) Issuing location administrative area code, 5 digits, see the Ministry of the Interior API documentation appendix 'Issuing location code comparison' for details.

  • 10001 北縣
  • 10002 宜縣
  • 10003 桃縣
  • 10004 竹縣
  • 10005 苗縣
  • 10006 中縣
  • 10007 彰縣
  • 10008 投縣
  • 10009 雲縣
  • 10010 嘉縣
  • 10011 南縣
  • 10012 高縣
  • 10013 屏縣
  • 10014 東縣
  • 10015 花縣
  • 10016 澎縣
  • 10017 基市
  • 10018 竹市
  • 10020 嘉市
  • 09007 連江
  • 09020 金門
  • 63000 北市
  • 64000 高市
  • 65000 新北市
  • 66000 or 10019 中市
  • 67000 or 10012 南市
  • 68000 桃市

Responses

Callbacks

Request samples

Content type
application/json
Example
{
  • "id_type": "ID_CARD",
  • "workflow_id": 200,
  • "country": "TWN",
  • "customer_reference": "000000123",
  • "locale": "zh-HK",
  • "success_url": null,
  • "error_url": null,
  • "expected_name": "王又曾",
  • "expected_birthday": "1990-06-21",
  • "expected_id_number": "A123456789",
  • "callback_url": "https://myserver.com/send/callback/here",
  • "auto_create_dd_task": true,
  • "dd_task_callback_url": "https://myserver.com/send/callback/here",
  • "dd_task_search_setting_id": 120,
  • "tw_id_apply_code": 2,
  • "tw_id_apply_date": "1070102",
  • "tw_id_issue_site_id": "10011"
}

Response samples

Content type
application/json
{}

Callback payload samples

Callback
POST: IDV task result callback
Content type
application/json
{
  • "idv_task_id": 12,
  • "country": "TWN",
  • "id_type": "ID_CARD",
  • "id_sub_type": "NATIONAL_ID",
  • "id_image_url": "https://static.kryptogo.com/id-image.jpg",
  • "id_back_image_url": "https://static.kryptogo.com/id-back-image.jpg",
  • "face_image_url": "https://static.kryptogo.com/face-image.jpg",
  • "id_and_face_image_url": "https://static.kryptogo.com/id-face-image.jpg",
  • "expected_name": "王又曾",
  • "expected_birthday": "1990-06-21",
  • "expected_id_number": "A123456789",
  • "expected_country": "TWN",
  • "expected_issuing_date": "2020-03-10",
  • "expected_expiry_date": "2025-03-10",
  • "expected_gender": "M",
  • "customer_reference": "000000123",
  • "first_name": "又曾",
  • "last_name": "王",
  • "full_name": "王又曾",
  • "birthday": "1965-03-16",
  • "id_number": "A223456789",
  • "issuing_date": "2020-03-10",
  • "expiry_date": "2025-03-10",
  • "gender": "M",
  • "state": 0,
  • "review_reasons": [
    ],
  • "reject_reasons": [
    ],
  • "created_search_task_id": 102,
  • "audit_status": "Accepted",
  • "audit_timestamp": 1641982000,
  • "auditor_employee_account": "admin",
  • "auditor_employee_name": "Admin",
  • "dd_tasks": [
    ]
}

Initiating an IDV transaction for mobile app verification

Call the RESTful API POST endpoint /idv/account with a JSON object containing the properties described below to create a transaction for each user. You will receive a JSON object in the response containing timestamp, idv_task_id and a sdk_token which is used in the mobile app integrated with jumio sdk to start the verification process.

Currently this API only supports Jumio IDV engine and ID_CARD verification.

There must be more than 500 points remaining to perform this operation. Points will be deducted after the user successfully uploads the verification information.

A DD search task can be created automatically from the recognized information in images.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

The body of the account initiate API request

workflow_id
required
integer

Applies this acquisition workflow to the transaction. Supported workflowId values:

  • 3 ID and Identity Verification
    • Verifies a photo ID document and returns a) whether that document is valid, and b) data extracted from that document.
    • It also compares the user's face with the photo on the ID and performs a liveness check to ensure the person is physically present.
country
required
string

The country of the ID. Should be ISO-3166 Alpha-3

expected_name
string

The expected full name of the ID holder. If it doesn't match the recognized name on the ID, the result state will be review

expected_birthday
string

The expected birthday of the ID holder in YYYY-MM-DD format. If it doesn't match the recognized birthday on the ID, the result state will be review

expected_id_number
string

The expected ID number of the ID holder. If it doesn't match the recognized ID number on the ID, the result state will be review

callback_url
string <uri>

The URL which will be called when the IDV task is completed

customer_reference
string

The internal customer reference of your system. Max length is 100

auto_create_dd_task
boolean

Whether to automatically create DD search task for the target if the result state is accept (default is false). If the result state is review or reject, the DD search task won't be created even this field is true

dd_task_callback_url
string

The callback URL to use if a DD search task is created from this IDV task

dd_task_search_setting_id
integer

The ID of search setting to use if a DD search task is created from this IDV task.

Required when a DD search task is created.

You can modify your search setting here. To know the ID of the search setting, check the url in the setting detail page. E.g., https://app.kryptogo.com/compliance/settings/search-settings/detail/2. Then the ID is 2.

tw_id_apply_code
integer

(Support when id_type = ID_CARD and country = TWN) Not Issue = 0, Initial Issue = 1, Reissue = 2, Change = 3

tw_id_apply_date
string

(Support when id_type = ID_CARD and country = TWN) Issuing date, Republic of China (ROC) format, 7 digits.

tw_id_issue_site_id
string

(Support when id_type = ID_CARD and country = TWN) Issuing location administrative area code, 5 digits, see the Ministry of the Interior API documentation appendix 'Issuing location code comparison' for details.

  • 10001 北縣
  • 10002 宜縣
  • 10003 桃縣
  • 10004 竹縣
  • 10005 苗縣
  • 10006 中縣
  • 10007 彰縣
  • 10008 投縣
  • 10009 雲縣
  • 10010 嘉縣
  • 10011 南縣
  • 10012 高縣
  • 10013 屏縣
  • 10014 東縣
  • 10015 花縣
  • 10016 澎縣
  • 10017 基市
  • 10018 竹市
  • 10020 嘉市
  • 09007 連江
  • 09020 金門
  • 63000 北市
  • 64000 高市
  • 65000 新北市
  • 66000 or 10019 中市
  • 67000 or 10012 南市
  • 68000 桃市

Responses

Callbacks

Request samples

Content type
application/json
{
  • "workflow_id": 3,
  • "country": "TWN",
  • "expected_name": "王又曾",
  • "expected_birthday": "1990-06-21",
  • "expected_id_number": "A123456789",
  • "callback_url": "https://myserver.com/send/callback/here",
  • "customer_reference": "000000123",
  • "auto_create_dd_task": true,
  • "dd_task_callback_url": "https://myserver.com/send/callback/here",
  • "dd_task_search_setting_id": 120,
  • "tw_id_apply_code": 2,
  • "tw_id_apply_date": "1070102",
  • "tw_id_issue_site_id": "10011"
}

Response samples

Content type
application/json
{
  • "idv_task_id": 15,
  • "sdk_token": "eyJhbGciOiJIUzUxMiI...umLYOxUj4u6wXYpcodRl2qtt0oOew63L7Hwg",
  • "timestamp": 1641807000
}

Callback payload samples

Callback
POST: IDV task result callback
Content type
application/json
{
  • "idv_task_id": 12,
  • "country": "TWN",
  • "id_type": "ID_CARD",
  • "id_sub_type": "NATIONAL_ID",
  • "id_image_url": "https://static.kryptogo.com/id-image.jpg",
  • "id_back_image_url": "https://static.kryptogo.com/id-back-image.jpg",
  • "face_image_url": "https://static.kryptogo.com/face-image.jpg",
  • "id_and_face_image_url": "https://static.kryptogo.com/id-face-image.jpg",
  • "expected_name": "王又曾",
  • "expected_birthday": "1990-06-21",
  • "expected_id_number": "A123456789",
  • "expected_country": "TWN",
  • "expected_issuing_date": "2020-03-10",
  • "expected_expiry_date": "2025-03-10",
  • "expected_gender": "M",
  • "customer_reference": "000000123",
  • "first_name": "又曾",
  • "last_name": "王",
  • "full_name": "王又曾",
  • "birthday": "1965-03-16",
  • "id_number": "A223456789",
  • "issuing_date": "2020-03-10",
  • "expiry_date": "2025-03-10",
  • "gender": "M",
  • "state": 0,
  • "review_reasons": [
    ],
  • "reject_reasons": [
    ],
  • "created_search_task_id": 102,
  • "audit_status": "Accepted",
  • "audit_timestamp": 1641982000,
  • "auditor_employee_account": "admin",
  • "auditor_employee_name": "Admin",
  • "dd_tasks": [
    ]
}