Finger KYC Public API

KYC and KYB Public API

A stable server-to-server API for creating verification profiles and reading the complete evidence record by profileId. Use the hosted Finger KYC flow for the user journey, then keep review and data synchronization in your own system.

Base URLhttps://api.fingerkyc.com/public/v1
AuthenticationBearer merchant API token
MethodsGET + POST only
ResponseApiResponse { success, code, data }
Public contract

One read model for your own review system

Create a KYC or KYB profile, send the user to the hosted flow, then read the current profile, evidence, people, and review state through one stable public namespace. The public API is not anonymous and is separate from the internal web routes.

Contract source: public_readme.md + /public/v1 controller

Internal routes such as `/api/web/kycService` and `/api/v1/kyb` are not part of the merchant contract. Route `/public/v1/**` through the Finger KYC Gateway.

01

Create a profile

Create a KYC or KYB profile and store the returned profileId in your system.

02

Create a Hosted JWT

Immediately before redirecting the end user, create a 30-minute Hosted JWT from your server with the merchant API Key. Never expose the API Key to the browser.

03

Open the hosted flow

Send the user to Finger KYC or Finger KYB with profileId and the Hosted JWT. Hosted KYB does not require the end user to have a FingerGrid SSO account.

04

Read the snapshot

Poll the lightweight profile endpoint, then fetch the complete snapshot when the user or automated checks change state.

05

Handle expiration

The Hosted JWT expires after 30 minutes. Show an expiration dialog and send the user back to your application so your server can issue a fresh token.

06

Review on your side

Use documents, evidence, people, tasks, validation, and review together. AI assists the process; it does not replace manual review.

Try this endpoint

Merchant API token

Enter a merchant API token and send one request using the selected endpoint's example values. The token is used only in this browser tab and is never stored.

The Gateway must authorize this token for the selected profile and scope.

Send a request to see the HTTP response here.
OpenAPI

Public API documentation

Open endpoint
Envelope

A predictable response shape

Every public endpoint uses the Finger KYC response envelope. Use success, code, and data.errorCode for logic; do not parse human-readable messages.

successboolean

true or false

codenumber

20000 success, 40001 invalid request, 40404 not found

messagestring

Human-readable diagnostic message

dataobject

Profile, snapshot, materials, people, or task payload