Vorg KYC


Pricing

Action
Price for the first 1000 requests to Vorg KYC in the billing month.
Price for subsequent requests to Vorg KYC in the billing month.

Initialization of the KYC procedure

0$ / request

0.5$ / request

Request to decrypt the KYC token.

0$ / request

0.1$ / request

Request a certificate confirming user verification.

1$ / request (Exception)

2$ / request (Exception)

Penalty for breach of confidentiality of data obtained through Vorg KYC: $10,000

White Label integration is not available.

You can pay for access to the EXPERT API in the Developer console for $50/month.


API base url: https://api.vvvorg.com/KYC/

Initialization of the KYC procedure

POST KYC-Initialize

Initialize the KYC procedure to obtain a KYC token, which can be used to direct the user to the verification page or used for a widget.

Headers

Name
Value

Content-Type

application/json

Authorization

App-token: <app access token>

Body

Parameter
Required?
Type
Description

client_id

yes

int

Your app’s Client ID.

security_key

yes

String

Security key generated on your side to protect data. Will be required to decrypt kyc-data-token.

vorgid_disabled

no (Available only with EXPERT API)

boolean

If you specify this parameter, the client will not be able to pass KYC using his Vorg ID account.

callback_type

yes

String

Can take one of the following values: Webhook, Websocket

webhook_url

If callback_type = webhook

URI

The link to which the response will be sent after completing the procedure.

payload

no

String

The value that will be returned with the response.

Response

{
  "success": "ok",
  "data": {
    "kyc-token": "<token>",
    "expires_in": 3600,
  },
}

Response body (If successful)

Parameter
Required?
Type
Description

success

yes

string

Always have the value ok.

data

yes

array

The response data.

data[kyc-token]

yes

string

Token required to initiate the KYC procedure.

data[expires_in]

yes

int

The number of seconds after which the token will no longer be usable.

Using KYC with a widget

If you are using a widget, the callback_type must be websocket.

To get started, install the Vorg KYC SDK on your site by importing the library in <head> :

<script type="text/javascript" src="https://unpkg.com/requirejs"></script>

Last updated

Was this helpful?