Authentication
Integration Guides
Customer Journey
- Customer API Overview
- 1. Registration
- 2. Authentication
- 3. Verification
- 4. Access Control
- Profile Management
- Profile Management
- B2C Profiles (SCT01)
- B2B Profiles (SCT02)
- Organization Management
Tenants's Journey
- Group Management
Financial Operations
- Beneficiary Management
Wallet & Payments
- Wallet API
Administration
- Configuration
- Billing
Create Individual Customer
API endpoint for creating a new individual customer account
POST
/
create
Copy
curl --request POST \
--url https://gateway.finhub.cloud/customer/2.0.0/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenantId: <tenantid>' \
--data '{
"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
}
}'
Copy
{
"customer": {
"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
}
}
}
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Tenant/Owner id
Body
application/json
Response
200
application/json
Create customer response
The response is of type object
.
Copy
curl --request POST \
--url https://gateway.finhub.cloud/customer/2.0.0/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenantId: <tenantid>' \
--data '{
"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
}
}'
Copy
{
"customer": {
"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
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.