Customer
Get customers by organization id
Home
Token
Merchant API
Customer
- 2FA
- AccessControl
- Active Session
- Credentials
- Customer
- POSTCreate a list of customers
- POSTAdd secret question
- POSTCreate customer address
- POSTCreate customer documents
- POSTCreate customer
- POSTGet all customers by tenant id
- GETGet customer details by customer id
- POSTGet customer details by email
- 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 organization get customers
- 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
- Profile Picture
Open Banking API
- Introduction
- POSTToken
- Account
- TPP
Customer
Get customers by organization id
POST
/
getByOrganization
/
{organizationId}
curl --request POST \
--url https://gateway.cyrexa.com/customer/1.0.0/getByOrganization/{organizationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenantId: <tenantid>' \
--header 'token: <token>' \
--data '{
"type": "<string>",
"created": "<string>",
"status": "<string>",
"pageNumber": 123,
"pageSize": 123
}'
{
"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.
Path Parameters
Body
application/json
Response
200
application/json
Get all customers by type response
Available options:
Person
, Organization
Available options:
new
, verified
, under_verificaiton
, blacklisted
, under_investigation
, dispute
, on_hold
, bancrupted
Available options:
category1
, category2
, category3
Available options:
Male
, Female
, Non-binary
, Transgender
, Other
, Prefer not to tell
Available options:
fixed
, mobile
, satellite
, virtual
Available options:
numbers
, international
, text
Available options:
KYB
, KYC
, PEP&SANCTION
Available options:
ID front side
, ID back side
, Passport
, accountAuthority
, shareholderStructure
, operationAddress
, registeredAddress
, selfie
, livelinessDetection
Available options:
underverification
, verified
, declined
, incomplete
, expired
curl --request POST \
--url https://gateway.cyrexa.com/customer/1.0.0/getByOrganization/{organizationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenantId: <tenantid>' \
--header 'token: <token>' \
--data '{
"type": "<string>",
"created": "<string>",
"status": "<string>",
"pageNumber": 123,
"pageSize": 123
}'
{
"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
}
}