Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Document Purpose
curl --request POST \
--url https://gateway.cyrexa.com/customer/1.0.0/organization/getByBusinessType/{businessType} \
--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
}'
[
{
"tenantId": "<string>",
"organizations": [
{
"countryOfCorporation": "<string>",
"legalName": "<string>",
"isTradingNameExist": false,
"tradingName": "<string>",
"taxRegistrationNumber": "<string>",
"taxIdentificationNumber": "<string>",
"dateOfIncorporation": "<string>",
"businesstypes": "<string>",
"sourceOfIncomingFund": "<string>",
"purposeOfAccount": "<string>",
"expectedAnnualActivityOfPlatform": "<string>",
"registrationNumber": "<string>",
"businessType": "Partner",
"shareholders": [
{
"id": "<string>",
"personFullname": "<string>",
"peerFullname": "<string>",
"escliationFullname": "<string>",
"status": "<string>",
"responsibility": "<string>",
"positions": "<string>",
"ownershipPercentage": "<string>",
"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": "<any>",
"operator": "<any>",
"encoding": "<any>",
"country": "<any>",
"number": "<any>",
"purpose": "<any>"
}
],
"addresses": [
{
"addressPurpose": "<any>",
"address": "<any>"
}
],
"documents": [
{
"purpose": "<any>",
"name": "<any>",
"documentType": "<any>",
"location": "<any>",
"verificationResponse": "<any>",
"status": "<any>",
"metadata": "<any>"
}
],
"SecretQuestion": [
{
"question": "<any>",
"answer": "<any>"
}
]
},
"escallation": {
"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": "<any>",
"operator": "<any>",
"encoding": "<any>",
"country": "<any>",
"number": "<any>",
"purpose": "<any>"
}
],
"addresses": [
{
"addressPurpose": "<any>",
"address": "<any>"
}
],
"documents": [
{
"purpose": "<any>",
"name": "<any>",
"documentType": "<any>",
"location": "<any>",
"verificationResponse": "<any>",
"status": "<any>",
"metadata": "<any>"
}
],
"SecretQuestion": [
{
"question": "<any>",
"answer": "<any>"
}
]
},
"peers": {
"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": "<any>",
"operator": "<any>",
"encoding": "<any>",
"country": "<any>",
"number": "<any>",
"purpose": "<any>"
}
],
"addresses": [
{
"addressPurpose": "<any>",
"address": "<any>"
}
],
"documents": [
{
"purpose": "<any>",
"name": "<any>",
"documentType": "<any>",
"location": "<any>",
"verificationResponse": "<any>",
"status": "<any>",
"metadata": "<any>"
}
],
"SecretQuestion": [
{
"question": "<any>",
"answer": "<any>"
}
]
}
}
],
"relatedTo": {
"relationType": "<string>",
"organizationID": "<string>"
},
"website": "<string>",
"businessSector": "<string>",
"rangeOfServicesOrGoods": "<string>",
"transactionPredict": {
"MonthlyVolumeRange": 123,
"NumberOfMonthlyPayment": 123,
"MaxSinglePayment": 123
},
"countryList": {
"SendList": [
"<string>"
],
"ReceiveList": [
"<string>"
]
},
"telephoneNumber": [
{
"phoneType": "<any>",
"operator": "<any>",
"encoding": "<any>",
"country": "<any>",
"number": "<any>",
"purpose": "<any>"
}
],
"addresses": [
{
"addressPurpose": "<any>",
"address": "<any>"
}
],
"documents": [
{
"purpose": "<any>",
"name": "<any>",
"documentType": "<any>",
"location": "<any>",
"verificationResponse": "<any>",
"status": "<any>",
"metadata": "<any>"
}
],
"businessToBusinessMap": [
{
"relationType": "Partner",
"tenannaId": "<string>",
"organizationId": "<string>",
"RelatingorganizationId": "<string>"
}
],
"businessToCustomerMap": [
{
"relationType": "Employee",
"tenannaId": "<string>",
"personid": "<string>",
"organizationId": "<string>"
}
]
}
],
"pagination": {
"numberOfPage": 123,
"totalSize": 123,
"currentPage": 123
}
}
]
curl --request POST \
--url https://gateway.cyrexa.com/customer/1.0.0/organization/getByBusinessType/{businessType} \
--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
}'
[
{
"tenantId": "<string>",
"organizations": [
{
"countryOfCorporation": "<string>",
"legalName": "<string>",
"isTradingNameExist": false,
"tradingName": "<string>",
"taxRegistrationNumber": "<string>",
"taxIdentificationNumber": "<string>",
"dateOfIncorporation": "<string>",
"businesstypes": "<string>",
"sourceOfIncomingFund": "<string>",
"purposeOfAccount": "<string>",
"expectedAnnualActivityOfPlatform": "<string>",
"registrationNumber": "<string>",
"businessType": "Partner",
"shareholders": [
{
"id": "<string>",
"personFullname": "<string>",
"peerFullname": "<string>",
"escliationFullname": "<string>",
"status": "<string>",
"responsibility": "<string>",
"positions": "<string>",
"ownershipPercentage": "<string>",
"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": "<any>",
"operator": "<any>",
"encoding": "<any>",
"country": "<any>",
"number": "<any>",
"purpose": "<any>"
}
],
"addresses": [
{
"addressPurpose": "<any>",
"address": "<any>"
}
],
"documents": [
{
"purpose": "<any>",
"name": "<any>",
"documentType": "<any>",
"location": "<any>",
"verificationResponse": "<any>",
"status": "<any>",
"metadata": "<any>"
}
],
"SecretQuestion": [
{
"question": "<any>",
"answer": "<any>"
}
]
},
"escallation": {
"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": "<any>",
"operator": "<any>",
"encoding": "<any>",
"country": "<any>",
"number": "<any>",
"purpose": "<any>"
}
],
"addresses": [
{
"addressPurpose": "<any>",
"address": "<any>"
}
],
"documents": [
{
"purpose": "<any>",
"name": "<any>",
"documentType": "<any>",
"location": "<any>",
"verificationResponse": "<any>",
"status": "<any>",
"metadata": "<any>"
}
],
"SecretQuestion": [
{
"question": "<any>",
"answer": "<any>"
}
]
},
"peers": {
"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": "<any>",
"operator": "<any>",
"encoding": "<any>",
"country": "<any>",
"number": "<any>",
"purpose": "<any>"
}
],
"addresses": [
{
"addressPurpose": "<any>",
"address": "<any>"
}
],
"documents": [
{
"purpose": "<any>",
"name": "<any>",
"documentType": "<any>",
"location": "<any>",
"verificationResponse": "<any>",
"status": "<any>",
"metadata": "<any>"
}
],
"SecretQuestion": [
{
"question": "<any>",
"answer": "<any>"
}
]
}
}
],
"relatedTo": {
"relationType": "<string>",
"organizationID": "<string>"
},
"website": "<string>",
"businessSector": "<string>",
"rangeOfServicesOrGoods": "<string>",
"transactionPredict": {
"MonthlyVolumeRange": 123,
"NumberOfMonthlyPayment": 123,
"MaxSinglePayment": 123
},
"countryList": {
"SendList": [
"<string>"
],
"ReceiveList": [
"<string>"
]
},
"telephoneNumber": [
{
"phoneType": "<any>",
"operator": "<any>",
"encoding": "<any>",
"country": "<any>",
"number": "<any>",
"purpose": "<any>"
}
],
"addresses": [
{
"addressPurpose": "<any>",
"address": "<any>"
}
],
"documents": [
{
"purpose": "<any>",
"name": "<any>",
"documentType": "<any>",
"location": "<any>",
"verificationResponse": "<any>",
"status": "<any>",
"metadata": "<any>"
}
],
"businessToBusinessMap": [
{
"relationType": "Partner",
"tenannaId": "<string>",
"organizationId": "<string>",
"RelatingorganizationId": "<string>"
}
],
"businessToCustomerMap": [
{
"relationType": "Employee",
"tenannaId": "<string>",
"personid": "<string>",
"organizationId": "<string>"
}
]
}
],
"pagination": {
"numberOfPage": 123,
"totalSize": 123,
"currentPage": 123
}
}
]
The access token received from the authorization server in the OAuth 2.0 flow.
Document Purpose
Show child attributes