Quickstart

Create a key, read a document, get a verdict. Three steps.

The API reads documents (extract) and verifies a profile (verify), two of the things Sahl does for lenders and banks. Bank connections and scoring are in the console. This is the real flow in v0.2.0. For a longer example see the walkthrough, and to try the calls without code see Test in the sandbox.

Before you start

1. Get the partner API enabled on your workspace. It is switched on per workspace by Sahl, not self-serve: request sandbox access.
2. In the console open Settings, then API Keys, then New key. Tick kyc:extract and kyc:verify. Copy the secret once. Keep it on your server.

Set it as SAHL_API_KEY. All samples use https://app.sahlfinancial.com/api, environment=sandbox and fake data. Use a fake image of a Moroccan national ID (CIN) of your own.

1. Read a document

Send 1 to 5 files (JPEG, PNG, WebP, TIFF or PDF, up to 30 MB each). Add a reference (your id for the client) to file the result on a case.

cURL

curl -X POST https://app.sahlfinancial.com/api/v1/kyc/extract \
  -H "Authorization: Bearer $SAHL_API_KEY" \
  -F "files=@cin-test.jpg" \
  -F "doc_type=national_id" \
  -F "reference=client-0001" \
  -F "environment=sandbox" > extracted.json

The answer has fields, documents, field_count, checks, reader_unavailable and policy. With a reference it also has case_id and document_ids. See Read documents.

2. Verify the profile

Send the documents entries back as they came, with the fields you hold.

cURL

jq '{reference: "client-0001", environment: "sandbox", subject: "Test Client", kind: "individual",
     values: {first_name: "Test", last_name: "Client"}, documents: .documents}' extracted.json |
curl -X POST https://app.sahlfinancial.com/api/v1/kyc/verify \
  -H "Authorization: Bearer $SAHL_API_KEY" \
  -H "Content-Type: application/json" \
  -d @-

3. Read the verdict

passed is true when no critical check failed. critical_failures and flags list what needs a person. A file with no photo ID among its documents fails with required:photo_id, so send the entries from step 1. /v1/kyc/assess takes the same body and adds a risk assessment.

Because of the reference, the case, its documents and the verdict are filed on your workspace, where your staff see them under Cases and Documents.

Next

Verify a profile

Every check, what it returns, how to read passed and flags.

Errors

Every status and code, with the fix.