Customer
Get customers document by purpose
- 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
- POSTCreate a list of customers
- POSTCreate customer address
- POSTCreate customer address
- POSTCreate customer documents
- POSTCreate customer
- POSTGet all customers by tenant id
- GETGet customer details by customer id
- GETGet customer documents by customer id
- POSTGet customers by customer status
- POSTGet customers by customer type
- POSTGet customers by organization id
- GETGet customers document by purpose
- GETGet SEPA id by customerId
- GETGet SEPA id by customerId and communicationChannel
- POSTPost update kycConfirmation
- POSTPost update pepCheckStatus
- POSTPost update revisions
- POSTUpdate customer status
- PUTUpdate customer
- POST
- 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
Customer
Get customers document by purpose
GET
/
documents
/
getByPurpose
/
{purpose}
/
{customerId}
Authorization
string
*
Bearer
Authorization
Required
string
The access token received from the authorization server in the OAuth 2.0 flow.
tenantId
string
*
tenantId
Required
string
Tenant/Owner id
purpose
array
*
purpose
Required
array
Document Purpose
customerId
string
*
customerId
Required
string
Customer Id
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Headers
tenantId
string
requiredTenant/Owner id
Path Parameters
purpose
enum<string>[]
requiredDocument Purpose
Available options:
KYB
, KYC
, PEP&SANCTION
customerId
string
requiredCustomer Id
Response
200 - application/json
tenantId
string
documents
object[]
documents.purpose
enum<string>
Available options:
KYB
, KYC
, PEP&SANCTION
documents.name
string
documents.documentType
enum<string>
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
documents.location
string
documents.verificationResponse
string
documents.status
enum<string>
Available options:
underverification
, verified
, declined
, incomplete
, expired
documents.metadata
object[]
documents.metadata.name
string
documents.metadata.type
enum<string>
Available options:
Number
, Boolean
, json
, string
documents.metadata.value
string