Token
AML
Country Data
Customer
- Access Control
- 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
Merchant API
Finsupport
- PUTTicket By Id
- PUTUpdate Ticket
- PUTEscalate
- PUTCustomer Close Ticket
- PUTAssignee Update Ticket Status
- PUTAdmin Update Ticket Status
- PUTAdmin Close Ticket
- PUTAdd Start Date
- PUTAdmin Complete Ticket For Assignee
- POSTSingle Upload
- POSTMultiple Upload
- POSTCustomer Reply On Ticket
- POSTCreate Ticket
- POSTCreate New Ticket
- POSTAssignee Reply On Ticket
- POSTAssignee Add Note
- POSTAdmin Reply On Ticket
- POSTAdmin Add Note
- POSTAdmin Add Assignee To The Ticket
- POSTAdd Follower To The Ticket
- GETTicket Status Enums
- GETTicket Report
- POSTTicket Report
- GETTicket Report Sort Order
- GETTicket Report Sort Fields
- GETRole Enums
- GETPriority Enums
- GETMy files
- GETTickets
- GETTickets by customer id
- GETList Of Tickets By Follower Id
- GETList Of Tickets By Assignee
- GETList Of Replies By Ticket Id
- GETList Of Notes By Ticket Id
- GETReply By Reply Id
- GETNote By Note Id
- GETList Of Follower By Ticket Id
- GETAssignee By Ticket Id
- GETCategory Enums
- GETSingle By Id
- GETAggregate
- GETAll By Note Id
- GETAll By Reply Id
- GETAll By Ticket Id
- GETAll file
- PUTReply Title Status
- GETReply Messages
- PUTReplay Messages
- POSTReplay Messages
- GETReplay Title
- POSTReplay Title
- GETReply Title By Id
- GETReply Messages by id
Get customers by customer status
POST
/
getByCustomerStatus
/
{customerStatus}
Copy
curl --request POST \
--url https://gateway.finhub.cloud/customer/2.0.0/getByCustomerStatus/{customerStatus} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenantId: <tenantid>' \
--data '{
"type": "<string>",
"created": "<string>",
"status": "<string>",
"pageNumber": 123,
"pageSize": 123
}'
Copy
{
"customers": [
{
"id": "<string>",
"customerType": "Person",
"customerName": "<string>",
"customerStatus": "new",
"categorization": "category1",
"notifications": [
{
"notificationType": "Marketingemails",
"isEnabled": true
}
],
"person": {
"firstName": {
"name": "<string>",
"order": 123,
"abbreviation": "<string>",
"language": "<string>",
"native": "<string>",
"suffix": "<string>",
"prefix": "<string>"
},
"lastName": {
"name": "<string>",
"order": 123,
"abbreviation": "<string>",
"language": "<string>",
"native": "<string>",
"suffix": "<string>",
"prefix": "<string>"
},
"fullName": "<string>",
"groupId": "<string>",
"gender": "Male",
"dateOfBirth": "<string>",
"placeOfBirth": "<string>",
"nationality": "<string>",
"pinCode": "<string>",
"password": "<string>",
"email": "<string>",
"telephoneNumbers": [
{
"phoneType": "fixed",
"operator": "<string>",
"encoding": "numbers",
"country": "<string>",
"number": "<string>",
"purpose": "<string>"
}
],
"addresses": [
{
"addressPurpose": "<string>",
"address": {
"country": "<string>",
"area": "<string>",
"zipCode": "<string>",
"city": "<string>",
"street": "<string>",
"streetNumber": [
"<string>"
],
"building": "<string>",
"apartment": "<string>",
"entrance": "<string>",
"floor": "<string>",
"doorNumber": "<string>",
"geoPosition": {
"latitude": 123,
"longitude": 123,
"altitude": 123
},
"alternative": {
"word1": "<string>",
"word2": "<string>",
"word3": "<string>"
},
"relatedToAddress": [
{
"relationType": "near_by",
"address": "<string>"
}
],
"additionalData": [
{
"name": "<string>",
"type": "Number",
"value": "<string>"
}
]
}
}
],
"documents": [
{
"purpose": "KYB",
"name": "<string>",
"documentType": "ID front side",
"location": "<string>",
"verificationResponse": "<string>",
"status": "underverification",
"metadata": [
{
"name": "<string>",
"type": "Number",
"value": "<string>"
}
]
}
],
"SecretQuestion": [
{
"question": "<string>",
"answer": "<string>"
}
]
},
"twofa": {
"targetType": "SMS",
"targetValue": "<string>",
"targetCode": "<string>",
"inputCode": "<string>",
"codematch": true
}
}
],
"pagination": {
"numberOfPage": 123,
"totalSize": 123,
"currentPage": 123
}
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Tenant/Owner id
Path Parameters
Customer Status
Body
application/json
Response
200
application/json
Get all customers by status response
The response is of type object
.
Copy
curl --request POST \
--url https://gateway.finhub.cloud/customer/2.0.0/getByCustomerStatus/{customerStatus} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenantId: <tenantid>' \
--data '{
"type": "<string>",
"created": "<string>",
"status": "<string>",
"pageNumber": 123,
"pageSize": 123
}'
Copy
{
"customers": [
{
"id": "<string>",
"customerType": "Person",
"customerName": "<string>",
"customerStatus": "new",
"categorization": "category1",
"notifications": [
{
"notificationType": "Marketingemails",
"isEnabled": true
}
],
"person": {
"firstName": {
"name": "<string>",
"order": 123,
"abbreviation": "<string>",
"language": "<string>",
"native": "<string>",
"suffix": "<string>",
"prefix": "<string>"
},
"lastName": {
"name": "<string>",
"order": 123,
"abbreviation": "<string>",
"language": "<string>",
"native": "<string>",
"suffix": "<string>",
"prefix": "<string>"
},
"fullName": "<string>",
"groupId": "<string>",
"gender": "Male",
"dateOfBirth": "<string>",
"placeOfBirth": "<string>",
"nationality": "<string>",
"pinCode": "<string>",
"password": "<string>",
"email": "<string>",
"telephoneNumbers": [
{
"phoneType": "fixed",
"operator": "<string>",
"encoding": "numbers",
"country": "<string>",
"number": "<string>",
"purpose": "<string>"
}
],
"addresses": [
{
"addressPurpose": "<string>",
"address": {
"country": "<string>",
"area": "<string>",
"zipCode": "<string>",
"city": "<string>",
"street": "<string>",
"streetNumber": [
"<string>"
],
"building": "<string>",
"apartment": "<string>",
"entrance": "<string>",
"floor": "<string>",
"doorNumber": "<string>",
"geoPosition": {
"latitude": 123,
"longitude": 123,
"altitude": 123
},
"alternative": {
"word1": "<string>",
"word2": "<string>",
"word3": "<string>"
},
"relatedToAddress": [
{
"relationType": "near_by",
"address": "<string>"
}
],
"additionalData": [
{
"name": "<string>",
"type": "Number",
"value": "<string>"
}
]
}
}
],
"documents": [
{
"purpose": "KYB",
"name": "<string>",
"documentType": "ID front side",
"location": "<string>",
"verificationResponse": "<string>",
"status": "underverification",
"metadata": [
{
"name": "<string>",
"type": "Number",
"value": "<string>"
}
]
}
],
"SecretQuestion": [
{
"question": "<string>",
"answer": "<string>"
}
]
},
"twofa": {
"targetType": "SMS",
"targetValue": "<string>",
"targetCode": "<string>",
"inputCode": "<string>",
"codematch": true
}
}
],
"pagination": {
"numberOfPage": 123,
"totalSize": 123,
"currentPage": 123
}
}
Assistant
Responses are generated using AI and may contain mistakes.