Dashboard API Example: Single candidate
Get status for a single candidate
Get status by refId
👉 refId is the local user ID you may have assigned to a user in the widget.
If you did not assign a refId, you can use the recordId returned by the widget. See below.
curl -X GET \
https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/refId/<REFID> \
-H 'Authorization: <API_Key' \
-H 'cache-control: no-cache'
import requests
r = requests.get("https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/refId/<REFID>", headers={"Authorization":"<api_key>"})
const request = require('request');
const options = {
url: 'https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/refId/<REFID>',
method: 'GET',
headers: {
'Authorization': '<api_key>'
}
}
request(options, function (error, response, body) {
console.log(response)
})
Get status by recordId
👉 recordId is returned by the widget when data have been successfully submitted.
curl -X GET \
https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/recordId/<RECORDID> \
-H 'Authorization: <API_Key' \
-H 'cache-control: no-cache'
import requests
r = requests.get("https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/recordId/<RECORDID>", headers={"Authorization":"<api_key>"})
const request = require('request');
const options = {
url: 'https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/recordId/<RECORDID>',
method: 'GET',
headers: {
'Authorization': '<api_key>'
}
}
request(options, function (error, response, body) {
console.log(response)
})
Response
Both routes above return current status and history of status changes
{
"status": "success",
"data": {
"status": "inreview",
"recordId": "5e5884feb785310019346655",
"refId": "1849-4849-3848-1944",
"isArchived": false,
"blockPassID": "5fe95a995f8c44000e972445",
"inreviewDate": "2018-11-12T10:49:17.973Z",
"waitingDate": "2018-11-12T10:49:03.017Z"
}
}
Get all data for a single candidate
Get status and raw data by refId
✋ You must select Include Identity attributes option when creating your API key to get all data of the user in the response.
👉 refId is the Local User ID (uuid) you may have assigned to a user in thewidget.
If you did not assign a refId, you can use the recordId returned by the widget. See below.
curl -X GET \
https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/refId/<REFID> \
-H 'Authorization: <API_Key' \
-H 'cache-control: no-cache'
import requests
r = requests.get("https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/refId/<REFID>", headers={"Authorization":"<api_key>"})
const request = require('request');
const options = {
url: 'https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/refId/<REFID>',
method: 'GET',
headers: {
'Authorization': '<api_key>'
}
}
request(options, function (error, response, body) {
console.log(response)
})
Get status and raw data by recordId
✋ You must select Include Identity attributes option when creating your API key to get all data of the user in the response.
curl -X GET \
https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/recordId/<RECORDID> \
-H 'Authorization: <API_Key' \
-H 'cache-control: no-cache'
import requests
r = requests.get("https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/recordId/<RECORDID>", headers={"Authorization":"<api_key>"})
const request = require('request');
const options = {
url: 'https://kyc.blockpass.org/kyc/1.0/connect/<CLIENT_ID>/recordId/<RECORDID>',
method: 'GET',
headers: {
'Authorization': '<api_key>'
}
}
request(options, function (error, response, body) {
console.log(response)
})
Response
Both routes above returns
{
"status": "success",
"data": {
"status": "inreview",
"refId": "1",
"isArchived": false,
"blockPassID": "5be95a995f8c44000e972445",
"inreviewDate": "2018-11-12T10:49:17.973Z",
"waitingDate": "2018-11-12T10:49:03.017Z",
"customFields": {
"RiskLevel": "Low"
},
"identities": {
"address": {
"type": "string",
"value": "{\"postalCode\":\"62576-6471\",\"city\":\"Luettgenchester\",\"address\":\"4611 Zieme Knoll\",\"extraInfo\":\"extra\",\"country\":\"VNM\",\"state\":\"\"}"
},
"dob": {
"type": "string",
"value": "12/31/2016"
},
"email": {
"type": "string",
"value": "[email protected]"
},
"family_name": {
"type": "string",
"value": "StromanBot"
},
"given_name": {
"type": "string",
"value": "Helmer"
},
"phone": {
"type": "string",
"value": "{\"countryCode\":\"VNM\",\"countryCode2\":\"vn\",\"phoneNumber\":\"+84987543212\",\"number\":\"987543212\"}"
},
"selfie_national_id": {
"type": "base64",
"value": "/9j/4AAQSkZJRgABAQEASABIAAD/<...>"
},
"proof_of_address": {
"type": "base64",
"value": "/9j/4AAQSkZJRgABAQEASABI<...>"
},
"selfie": {
"type": "base64",
"value": "/9j/4AAQSkZJRgABAQEA<...>"
},
"passport": {
"type": "base64",
"value": "/9j/4AAQSkZJ<...>"
}
},
"certs": {
"onfido-service-cert": "{\"@context\":[{\"@version\":1.1},,<...>",
"complyadvantage-service-cert": "{\"@context\":[{\"@version\":1.1},<...>"
}
}
}