FK
FinKYCby Finaya
Getting Started
DashboardApplicationsCustomers
KYC (PF)KYB (PJ)ScreeningKYC SessionsBiometric AuthProof of AddressQuestionnaires
CasesAgingRiskEvidenceApproval ChainsLegal HoldsSARs (LGPD)ConsentsCOAFRisk Policy v2Risk DriftCorporate Groups
WorkflowsMarketplaceBatch ImportBlocklistDoc Expiries
Business LinesUsersWhite LabelAPI ReferenceBillingSettingsEmail TemplatesHelp & FAQ
api-docs

API Reference

FinKYC REST API — v1.0.0

Interactive Docs
Try API endpoints directly in your browser
Open Swagger UI
API Reference
Clean, readable API documentation
Open ReDoc
API Keys
Manage your B2B integration credentials
Manage Keys
Authentication
JWT Bearer
For dashboard users
Authorization: Bearer eyJhbGci...
API Key
For B2B integrations
X-API-Key: fk_live_...
Endpoint Groups
All available API endpoint groups
auth
Login, refresh, TOTP, password reset
applications
KYC application lifecycle
screenings
PEP & sanctions screening
verifications
OCR, liveness, face-match
risk
Risk scoring & decisions
cases
Manual review queue
businesses
KYB & Firmas e Poderes
monitoring
Ongoing monitoring
workflows
BPMN workflow engine
audit
Immutable audit log
users
User management
admin
Cross-tenant admin ops
settings
Tenant configuration
onboarding
Onboarding checklist
sandbox
Sandbox mode management
API Key Scopes
Control what operations each API key can perform
read
Read-only access to all resources
write
Create and update resources
admin
Full administrative access
kyb
KYB business verification operations
screening
PEP/sanctions screening operations

Update scopes via PUT /v1/settings/api-keys/<prefix>/scopes

Sandbox Mode
Test the API safely without affecting real data

Enable sandbox mode to isolate test data. Sandbox applications are flagged with "sandbox": true in their metadata and can be bulk-deleted without affecting production records.

# Enable sandbox mode

POST /v1/sandbox/enable

# Reset sandbox data

DELETE /v1/sandbox/data

# Disable sandbox mode

POST /v1/sandbox/disable

SDK Generation
Generate typed client SDKs from the OpenAPI spec

# Install generator

npm install -g @openapitools/openapi-generator-cli

# Generate TypeScript + Python SDKs

./scripts/generate_sdk.sh all

# TypeScript only

./scripts/generate_sdk.sh typescript

# Python only

./scripts/generate_sdk.sh python

SDKs are generated in the sdk/ directory (git-ignored). Set FINKYC_API_URL to point to a non-local backend.

TypeScript SDK usage example:

// Import generated client

import { ApplicationsApi, Configuration } from '@finaya/finkyc-sdk';

const config = new Configuration({ basePath: 'https://api.finaya.com', accessToken: token });

const api = new ApplicationsApi(config);

const apps = await api.listApplications({ page: 1 });