KYC API
Preform KYC verification on external users using this API.
Last updated
Preform KYC verification on external users using this API.
Last updated
If you use the JavaScript SDK you could use the KycApi abstraction instead.
You need the kyc:read scope to access this endpoints.
GET https://identity.vulos.io/api/v1/kyc/:id
Get the status of a KYC verification instance.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
GET https://identity.vulos.io/api/v1/kyc/list
List the KYC verification instances that were created by the application's owner.
| Name | Type | Description |
|---|---|---|
You need the kyc:write scope to access this endpoints.
POST https://identity.vulos.io/api/v1/kyc/upload
Upload KYC verification files for future use.
POST https://identity.vulos.io/api/v1/kyc/create
Create a KYC verification instance.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
id*
String
The ID of the KYC verification instance.
Authorization*
String
Basic authentication with the application client ID as the username and the client secret (if any) as the password.
page
Number
The page number (defaults to 0).
pageSize
Number
The number of instances per page (defaults to 10).
Authorization*
String
Basic authentication with the application client ID as the username and the client secret (if any) as the password.
Content-Type*
String
multipart/form-data
Authorization*
String
Basic authentication with the application client ID as the username and the client secret (if any) as the password.
selfiePicture*
File
The selfie picture of the user.
idCardPicture*
File
The id card picture of the user.
Content-Type*
String
multipart/form-data
Authorization*
String
Basic authentication with the application client ID as the username and the client secret (if any) as the password.
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).