Get a KYC check
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"check": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kyc_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "basic",
"status": "pending",
"block_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"version": 123,
"reject_labels": [
"<string>"
],
"comments": "<string>"
},
"mobile_sdk_token": "<string>",
"web_sdk_url": "<string>"
}{
"code": 123,
"message": "<string>",
"reason": "<string>"
}KYC
Get a KYC check
Retrieves a KYC check and, when requested, credentials for completing it.
Pass include_credentials only for the client experience you use. Treat
returned credentials as short-lived secrets and do not log them. For a
resubmission, retrieve fresh credentials before sending the user back to
the verification flow. If the check does not belong to the KYC profile,
the response is 404.
GET
/
v1
/
kyc
/
profiles
/
{kyc_profile_id}
/
checks
/
{check_id}
Get a KYC check
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.prod.gnosispay.com/partner-api/v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"check": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kyc_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "basic",
"status": "pending",
"block_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"version": 123,
"reject_labels": [
"<string>"
],
"comments": "<string>"
},
"mobile_sdk_token": "<string>",
"web_sdk_url": "<string>"
}{
"code": 123,
"message": "<string>",
"reason": "<string>"
}Path Parameters
The unique identifier of the KYC profile.
The unique identifier of the KYC check.
Query Parameters
Include SDK credentials in the response.
Available options:
mobile_sdk_token, web_sdk_url