Customer
Get customers by customer status
- 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 by customer status
POST
/
getByCustomerStatus
/
{customerStatus}
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
customerStatus
array
*
customerStatus
Required
array
Customer Status
object
type
string
type
string
created
string
created
string
status
string
status
string
pageNumber
integer
pageNumber
integer
pageSize
integer
pageSize
integer
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
customerStatus
enum<string>[]
requiredCustomer Status
Available options:
new, verified, under_verificaiton, blacklisted, under_investigation, dispute, on_hold, bancrupted Body
application/json
type
string
created
string
status
string
pageNumber
integer
pageSize
integer
Response
200 - application/json
customers
object[]
customers.id
string
customers.customerType
enum<string>
Available options:
Person, Organization customers.customerName
string
customers.customerStatus
enum<string>
Available options:
new, verified, under_verificaiton, blacklisted, under_investigation, dispute, on_hold, bancrupted customers.categorization
enum<string>
Available options:
category1, category2, category3 customers.notifications
object[]
customers.notifications.notificationType
enum<string>
Available options:
Marketingemails, Marketingnotifications, Friendsvisibility customers.notifications.isEnabled
boolean
customers.person
object
customers.person.firstName
object
customers.person.firstName.name
string
customers.person.firstName.order
integer
customers.person.firstName.abbreviation
string
customers.person.firstName.language
string
customers.person.firstName.native
string
customers.person.firstName.suffix
string
customers.person.firstName.prefix
string
customers.person.lastName
object
customers.person.lastName.name
string
customers.person.lastName.order
integer
customers.person.lastName.abbreviation
string
customers.person.lastName.language
string
customers.person.lastName.native
string
customers.person.lastName.suffix
string
customers.person.lastName.prefix
string
customers.person.fullName
string
customers.person.groupId
string
customers.person.gender
enum<string>
Available options:
Male, Female, Non-binary, Transgender, Other, Prefer not to tell customers.person.dateOfBirth
string
customers.person.placeOfBirth
string
customers.person.nationality
string
customers.person.pinCode
string
customers.person.password
string
customers.person.email
string
customers.person.telephoneNumbers
object[]
customers.person.telephoneNumbers.phoneType
enum<string>
Available options:
fixed, mobile, satellite, virtual customers.person.telephoneNumbers.operator
string
customers.person.telephoneNumbers.encoding
enum<string>
Available options:
numbers, international, text customers.person.telephoneNumbers.country
string
customers.person.telephoneNumbers.number
string
customers.person.telephoneNumbers.purpose
string
customers.person.addresses
object[]
customers.person.addresses.addressPurpose
string
customers.person.addresses.address
object
customers.person.addresses.address.country
string
customers.person.addresses.address.area
string
customers.person.addresses.address.zipCode
string
customers.person.addresses.address.city
string
customers.person.addresses.address.street
string
customers.person.addresses.address.streetNumber
string[]
customers.person.addresses.address.building
string
customers.person.addresses.address.apartment
string
customers.person.addresses.address.entrance
string
customers.person.addresses.address.floor
string
customers.person.addresses.address.doorNumber
string
customers.person.addresses.address.geoPosition
object
customers.person.addresses.address.geoPosition.latitude
number
customers.person.addresses.address.geoPosition.longitude
number
customers.person.addresses.address.geoPosition.altitude
number
customers.person.addresses.address.alternative
object
customers.person.addresses.address.alternative.word1
string
customers.person.addresses.address.alternative.word2
string
customers.person.addresses.address.alternative.word3
string
customers.person.addresses.address.relatedToAddress
object[]
customers.person.addresses.address.relatedToAddress.relationType
enum<string>
Available options:
near_by, crossing, opposite_to, inside_of, behind, infront customers.person.addresses.address.relatedToAddress.address
string
customers.person.addresses.address.additionalData
object[]
customers.person.addresses.address.additionalData.name
string
customers.person.addresses.address.additionalData.type
enum<string>
Available options:
Number, Boolean, json, string customers.person.addresses.address.additionalData.value
string
customers.person.documents
object[]
customers.person.documents.purpose
enum<string>
Available options:
KYB, KYC, PEP&SANCTION customers.person.documents.name
string
customers.person.documents.documentType
enum<string>
Available options:
ID front side, ID back side, Passport, accountAuthority, shareholderStructure, operationAddress, registeredAddress, selfie, livelinessDetection customers.person.documents.location
string
customers.person.documents.verificationResponse
string
customers.person.documents.status
enum<string>
Available options:
underverification, verified, declined, incomplete, expired customers.person.documents.metadata
object[]
customers.person.documents.metadata.name
string
customers.person.documents.metadata.type
enum<string>
Available options:
Number, Boolean, json, string customers.person.documents.metadata.value
string
customers.person.SecretQuestion
object[]
customers.person.SecretQuestion.question
string
customers.person.SecretQuestion.answer
string
customers.twofa
object
customers.twofa.targetType
enum<string>
Available options:
SMS, Email customers.twofa.targetValue
string
customers.twofa.targetCode
string
customers.twofa.inputCode
string
customers.twofa.codematch
boolean
pagination
object
pagination.numberOfPage
integer
pagination.totalSize
integer
pagination.currentPage
integer