- Documentation
- SEPA's API
- API Explore
- Community
- Welcome to FinHub
- GETGet document
- GETGet documents
- GETGet verification result
- POSTPost document upload
- PUTPut document status
- PUTPut document update
- GETGet card balance
- GETGet card pin
- GETGet card product config
- GETGet card product list
- GETGet card product
- GETGet card transactions
- GETGet card usage
- GETGet card
- GETGet cardholder
- GETGet EHIMode configuration
- GETGet issuer
- POSTPost card credit
- POSTPost card debit
- POSTPost card product setup
- POSTPost card product
- POSTPost card transfers
- POSTPost card usage
- POSTPost card
- POSTPost cardholder
- POSTPost EHIMode configuration
- POSTPost issuer
- PUTPut card account
- PUTPut card activate
- PUTPut card cardholder
- PUTPut card lost
- PUTPut card pin
- PUTPut card product config
- PUTPut card stolen
- PUTPut card suspend
- PUTPut cardholder
- PUTPut EHIMode configuration
- PUTPut issuer
Private
Public
2FA
AccessControl
Active Session
Credentials
Customer
Organization
- POSTPost send
- POSTGenerateToken
IPG Backoffice APIs
IPG Payment APIs
Company
EIN Verification
IBAN Verification
NIF Verification
Product
System
TIN Verification
VAT Verification
- POSTPost authorize
- POSTPost backgroundcheck
- POSTPost delete info
- POSTPost face
- POSTPost get info
- POSTPost scan documents
- POSTPost upload image
- PUTPut backgroundcheck
Global Settings
Rules
Smart Contract
Admin
Allowed Operation
Assets
Currency
Currency Pairs
Dashboard
Fee
Limit
Misc
Operation Address
Operation Destination
Order
Transactions
Wallets
Introduction
AML
CMS
Crypto
Customer
muse-openapi
IPG
KYB
KYC
Smart Contract
Wallet
KYC
Post scan documents
POST
/
scanDocuments
Authorization
string
*
Bearer
Authorization
Required
string
The access token received from the authorization server in the OAuth 2.0 flow.
X-token
string
*
X-token
Required
string
authentication token from /authorize response
object
*
country
enum<string>
country
enum<string>
documentType
enum<string>
*
documentType
Required
enum<string>
frontImage
string
*
frontImage
Required
string
backImage
string
backImage
string
disableExpiryValidation
boolean
*
disableExpiryValidation
Required
boolean
exportFaceImage
boolean
*
exportFaceImage
Required
boolean
startSession
boolean
startSession
boolean
curl --request POST \
--url https://gateway.finhub.cloud/kyc/1.0.0/scanDocuments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-token: <x-token>' \
--data '{
"country": "UAE",
"documentType": "PASSPORT",
"frontImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDA",
"backImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDA",
"disableExpiryValidation": true,
"exportFaceImage": false,
"startSession": true
}'
{
"requireManualReview": true,
"sessionId": "e63fd1c3-07a4-4b86-84dc-e93289ab3eda",
"front": {
"secondaryId": "MARIA",
"primaryId": "DELA CRUZ",
"dateOfBirth": "800316",
"dateOfExpiry": "210626",
"documentNumber": "P0000000A",
"nationality": "PHL",
"issuer": "PHL",
"sex": "F",
"documentCode": "P",
"mrzText": "P<PHLDELA<CRUZ<<MARIA<<<<<<<<<<<<<<<<<<<<<<<\nP0000000A0PHL8003166F2106269<<<<<<<<<<<<<<02",
"mrzVerified": false,
"chipAvailable": true
},
"back": {},
"analysis": {
"front": {
"copy": 100
}
}
}
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Headers
X-token
string
requiredauthentication token from /authorize response
Body
application/json
country
enum<string>
Available options:
UAE
, OMN
, PAK
, SAU
, BHR
, KWT
, QAT
, NLD
, OTHER
documentType
enum<string>
requiredAvailable options:
PASSPORT
, ID
, DRIVER_LICENCE
, VEHICLE_LICENCE
, VISA_DOCUMENT
, SELFIE
, UTILITY_BILL
, PROOF_OF_RESIDENCE
, BANK_STATEMENT
frontImage
string
requiredbackImage
string
disableExpiryValidation
boolean
requiredexportFaceImage
boolean
requiredstartSession
boolean
Response
default - application/json
sessionId
string
front
object
front.secondaryId
string
front.primaryId
string
front.dateOfBirth
string
front.dateOfExpiry
string
front.documentNumber
string
front.nationality
string
front.issuer
string
front.sex
string
front.documentCode
string
front.mrzText
string
front.mrzVerified
boolean
front.chipAvailable
boolean
back
object
back.secondaryId
string
back.primaryId
string
back.dateOfBirth
string
back.dateOfExpiry
string
back.documentNumber
string
back.nationality
string
back.issuer
string
back.sex
string
back.documentCode
string
back.mrzText
string
back.mrzVerified
boolean
back.chipAvailable
boolean
analysis
object
analysis.front
object
analysis.front.copy
integer
analysis.back:
object
analysis.back:.copy
integer
curl --request POST \
--url https://gateway.finhub.cloud/kyc/1.0.0/scanDocuments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-token: <x-token>' \
--data '{
"country": "UAE",
"documentType": "PASSPORT",
"frontImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDA",
"backImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDA",
"disableExpiryValidation": true,
"exportFaceImage": false,
"startSession": true
}'
{
"requireManualReview": true,
"sessionId": "e63fd1c3-07a4-4b86-84dc-e93289ab3eda",
"front": {
"secondaryId": "MARIA",
"primaryId": "DELA CRUZ",
"dateOfBirth": "800316",
"dateOfExpiry": "210626",
"documentNumber": "P0000000A",
"nationality": "PHL",
"issuer": "PHL",
"sex": "F",
"documentCode": "P",
"mrzText": "P<PHLDELA<CRUZ<<MARIA<<<<<<<<<<<<<<<<<<<<<<<\nP0000000A0PHL8003166F2106269<<<<<<<<<<<<<<02",
"mrzVerified": false,
"chipAvailable": true
},
"back": {},
"analysis": {
"front": {
"copy": 100
}
}
}