KYC API
Preform KYC verification on external users using this API.
If you use the JavaScript SDK you could use the KycApi
abstraction instead.
You need the kyc:read
scope to access this endpoints.
KYC Instance Status
GET
https://identity.vulos.io/api/v1/kyc/:id
Get the status of a KYC verification instance.
Path Parameters
Name | Type | Description |
---|---|---|
id* | String | The ID of the KYC verification instance. |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Basic authentication with the application client ID as the username and the client secret (if any) as the password. |
KYC Instance List
GET
https://identity.vulos.io/api/v1/kyc/list
List the KYC verification instances that were created by the application's owner.
Query Parameters
Name | Type | Description |
---|---|---|
page | Number | The page number (defaults to 0). |
pageSize | Number | The number of instances per page (defaults to 10). |
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Basic authentication with the application client ID as the username and the client secret (if any) as the password. |
You need the kyc:write
scope to access this endpoints.
KYC File Upload
POST
https://identity.vulos.io/api/v1/kyc/upload
Upload KYC verification files for future use.
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String |
|
Authorization* | String | Basic authentication with the application client ID as the username and the client secret (if any) as the password. |
Request Body
Name | Type | Description |
---|---|---|
selfiePicture* | File | The selfie picture of the user. |
idCardPicture* | File | The id card picture of the user. |
KYC Instance Create
POST
https://identity.vulos.io/api/v1/kyc/create
Create a KYC verification instance.
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String |
|
Authorization* | String | Basic authentication with the application client ID as the username and the client secret (if any) as the password. |
Request Body
Name | Type | Description |
---|---|---|
selfiePicture | File | The selfie picture of the user (required if no URL is specified). |
idCardPicture | File | The id card picture of the user (required if no URL is specified). |
selfiePictureUrl | String | An URI returned by the upload endpoint. |
idCardPictureUrl | String | An URI returned by the upload endpoint. |
webhook | String | A webhook that gets called when the KYC verification completes (the same data is sent that the status endpoint returns, minus the webhook field and with an additional id field). |
Last updated