Download an eID report
curl --request GET \
--url https://app.sahlfinancial.com/api/v1/kyc/eid/{key}/report \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sahlfinancial.com/api/v1/kyc/eid/{key}/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.sahlfinancial.com/api/v1/kyc/eid/{key}/report"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)"<string>"{
"detail": "Invalid or revoked API key"
}{
"detail": {
"code": "kyc_scope_not_allowed",
"message": "This workspace is not enabled for the partner KYC API."
}
}{
"detail": "Not Found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"code": "rate_limit_exceeded",
"message": "Too many requests. Please slow down."
}{
"code": "internal_error",
"message": "An unexpected error occurred",
"details": null
}{
"detail": "the identity verification service did not answer"
}Download an eID report
Required scope: kyc:eid.
the eID provider’s PDF report of a completed check, for the client’s file.
Guide: eID check.
GET
/
v1
/
kyc
/
eid
/
{key}
/
report
Download an eID report
curl --request GET \
--url https://app.sahlfinancial.com/api/v1/kyc/eid/{key}/report \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sahlfinancial.com/api/v1/kyc/eid/{key}/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.sahlfinancial.com/api/v1/kyc/eid/{key}/report"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)"<string>"{
"detail": "Invalid or revoked API key"
}{
"detail": {
"code": "kyc_scope_not_allowed",
"message": "This workspace is not enabled for the partner KYC API."
}
}{
"detail": "Not Found"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"code": "rate_limit_exceeded",
"message": "Too many requests. Please slow down."
}{
"code": "internal_error",
"message": "An unexpected error occurred",
"details": null
}{
"detail": "the identity verification service did not answer"
}Authorizations
API key created in the console. Scopes: kyc:extract, kyc:verify, kyc:eid; bank:read, bank:write (Growth plan, enabled per workspace by Sahl).
Path Parameters
The key returned by POST /v1/kyc/eid.
Response
The PDF report (Content-Disposition: attachment; filename="eid-<key>.pdf").
The response is of type file.