> ## Documentation Index > Fetch the complete documentation index at: https://docs.deeptrack.io/llms.txt > Use this file to discover all available pages before exploring further. # Run a KYC identity check > Document scan, liveness, face match, IPRS (Kenya's national register) and AML screening of the person. Scope `verify:kyc`. Each media field is at most 1,000,000 base64 characters. ## OpenAPI ````yaml /sentinel/openapi.yaml post /v1/verify/idp openapi: 3.1.0 info: title: Sentinel API version: 1.0.0 summary: >- KYC, KYB, AML screening, document (IDP) checks and transaction monitoring for Kenya and East Africa. description: | The Sentinel API by Deeptrack lets your systems run identity, business and AML checks without opening the dashboard. **Authentication.** Send your API key as a bearer token: `Authorization: Bearer gt_live_…` (or `gt_test_…`). Create keys in Sentinel under **Developer → API Keys**. Each key has scopes; a key without the scope a route needs gets `403`. **Test mode.** Test keys (`gt_test_`) return a sandbox result at once (`status: completed`, `verdict: pass`, `sandbox: true`), are never charged, and store none of the names, numbers or images you send. **Asynchronous checks.** `POST /v1/verify/*` answers `202` with an `id`. The result arrives by webhook (`sentinel.scan.complete`) or with `GET /v1/verify/{id}`. **Errors.** Every error is JSON with an `error` message; validation errors add `details`, describing what each field takes. **Rate limits.** Per key, by plan (Trial 10/min, Starter 60, Growth 200, Business 500, Enterprise 1,000), plus an organization-wide cap. A limited request gets `429` with `Retry-After` in seconds. **Pagination.** List endpoints take `limit` (1–100) and `before`; pass the previous answer's `nextCursor` as `before` to get the next page. `nextCursor` is `null` on the last page. Guides with curl, Node and Python examples are in the Sentinel manual, chapters C1 to C9. contact: name: Deeptrack email: tech@deeptrack.io url: https://deeptrack.io x-changelog: See the manual, chapter C9 (API reference, OpenAPI and Postman). servers: - url: https://robust-parakeet-542.convex.site description: >- Sentinel production API. Shown on the API Keys page; it may move to an api.* address, which will be announced in C9. security: - bearerAuth: [] tags: - name: KYC description: Identity checks (document, liveness, face match, IPRS and AML). - name: KYB description: Business checks (registration, address, directors and owners). - name: Documents description: >- IDP document checks (identity documents, proof of address, KRA PIN certificates). - name: AML description: Sanctions, PEP and watch-list screening, and ongoing monitoring. - name: Transactions description: Transaction monitoring (Business and Enterprise plans, and the trial). - name: Capture links description: Links a customer opens on their phone to capture their ID and a selfie. - name: Results description: Read checks and their results. - name: Credits description: Credit balance, prices and usage. paths: /v1/verify/idp: post: tags: - KYC summary: Run a KYC identity check description: | Document scan, liveness, face match, IPRS (Kenya's national register) and AML screening of the person. Scope `verify:kyc`. Each media field is at most 1,000,000 base64 characters. operationId: createKycCheck requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KycRequest' example: documentFrontBase64: /9j/4AAQSkZJRg… documentBackBase64: /9j/4AAQSkZJRg… livenessFramesBase64: /9j/4AAQSkZJRg… livenessMediaType: jpeg_frames idNumber: '30458812' firstName: Wanjiku lastName: Mwangi dateOfBirth: '1992-04-17' gender: F responses: '202': $ref: '#/components/responses/CheckAccepted' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/InsufficientCredits' '403': $ref: '#/components/responses/Forbidden' '413': $ref: '#/components/responses/TooLarge' '429': $ref: '#/components/responses/RateLimited' components: schemas: KycRequest: type: object required: - documentFrontBase64 - livenessFramesBase64 - livenessMediaType - idNumber - firstName - lastName - dateOfBirth - gender properties: documentFrontBase64: type: string description: Base64 JPEG or PNG of the ID front. documentBackBase64: type: string description: Base64 of the back (ID cards and licences). livenessFramesBase64: type: string description: Base64 liveness capture. livenessMediaType: type: string enum: - jpeg_frames - mp4 - webm idNumber: type: string maxLength: 200 firstName: type: string maxLength: 200 lastName: type: string maxLength: 200 dateOfBirth: type: string maxLength: 200 description: YYYY-MM-DD. gender: type: string maxLength: 200 CheckAccepted: type: object required: - id - type - status properties: id: type: string examples: - ver_3f9a1c0b7d2e4a51c8e0f6a29b4d7c13 type: type: string enum: - idp - aml - document - kyb status: type: string enum: - queued - completed verdict: type: string const: pass description: Test keys only. sandbox: type: boolean description: Test keys only. monitoringId: type: - string - 'null' description: >- AML only, when `monitor: true` was sent: the monitored subject's id (null with a test key). Error: type: object required: - error properties: error: type: string details: type: object additionalProperties: true responses: CheckAccepted: description: >- The check was accepted. Live keys start `queued`; test keys finish at once. content: application/json: schema: $ref: '#/components/schemas/CheckAccepted' BadRequest: description: Missing or invalid fields. `details` describes what each field takes. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: 'Missing required fields: subjectName' details: subjectName: string of at most 200 characters Unauthorized: description: Missing, malformed, unknown or revoked API key. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Invalid API key InsufficientCredits: description: The balance is too low for this check (live keys only). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Insufficient credits Forbidden: description: >- The key lacks the scope, the IP address isn't allowed, the plan doesn't include the feature, or the account isn't active. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: >- This API key can't call POST /v1/verify/aml. Give it the "verify:aml" scope or use another key. TooLarge: description: A file or media field is over its size limit. content: application/json: schema: $ref: '#/components/schemas/Error' RateLimited: description: Too many requests. Wait `Retry-After` seconds. headers: Retry-After: schema: type: integer description: Seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Rate limit exceeded securitySchemes: bearerAuth: type: http scheme: bearer description: 'Your API key: gt_live_… or gt_test_…' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.