ClearSignal API Reference
Complete API documentation for the ClearSignal API, automatically generated from the OpenAPI specification.
GET /administration/users
GET
/administration/users
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Responses
OK
JSON
[
{
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"enabled": true,
"createdAt": "string",
"telephone": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postalCode": "string",
"county": "string",
"country": "string",
"billingPlan": "string",
"stripeSubscriptionId": "string",
"stripeCustomerId": "string",
"riskPolicyContents": [
{
"autoId": 0,
"title": "string",
"content": "string",
"customerId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"processingStatus": "string",
"processedPolicyAutoId": 0,
"errorMessage": "string",
"customer": "[Circular Reference]",
"processedPolicyAuto": {
"autoId": 0,
"policyName": "string",
"policyId": "string",
"policyVersion": "string",
"currency": "string",
"createdDate": "string",
"updatedDate": "string",
"isActive": true,
"policyJson": "string",
"riskPolicyContents": [
{
}
],
"riskPolicyRules": [
{
"autoId": 0,
"ruleId": "string",
"policyAutoId": 0,
"policyId": "string",
"description": "string",
"maxExposure": 0,
"createdDate": "string",
"updatedDate": "string",
"policyAuto": "[Circular Reference]",
"riskPolicyApplicability": {
"applicabilityId": 0,
"ruleAutoId": 0,
"ruleId": "string",
"maxPd": 0,
"createdDate": "string",
"updatedDate": "string",
"riskPolicyApplicabilityCountries": [
{
"applicabilityCountryId": 0,
"applicabilityId": 0,
"countryCode": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"riskPolicyApplicabilityRiskRatings": [
{
"riskRatingId": 0,
"applicabilityId": 0,
"riskRating": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"ruleAuto": "[Circular Reference]"
},
"riskPolicyRulesConditions": [
{
"conditionId": 0,
"ruleAutoId": 0,
"ruleId": "string",
"condition": "string",
"conditionOrder": 0,
"createdDate": "string",
"ruleAuto": "[Circular Reference]"
}
]
}
]
}
}
],
"spheres": [
{
"autoId": 0,
"name": "string",
"customerId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"customer": "[Circular Reference]"
}
],
"subscription": {
"autoId": 0,
"name": "string",
"amlCredits": 0,
"idvCredits": 0,
"kycCredits": 0,
"kybCredits": 0,
"stripeProductId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabed": true,
"customers": [
{
}
],
"stripeProduct": {
"autoId": 0,
"productId": "string",
"object": "string",
"active": true,
"created": "string",
"defaultPriceId": "string",
"deleted": true,
"description": "string",
"livemode": true,
"name": "string",
"shippable": true,
"statementDescriptor": "string",
"taxCodeId": "string",
"type": "string",
"unitLabel": "string",
"updated": "string",
"url": "string",
"stripeProductsPrices": [
{
"autoId": 0,
"stripeProductId": 0,
"priceId": "string",
"object": "string",
"active": true,
"billingScheme": "string",
"created": "string",
"currency": "string",
"deleted": true,
"livemode": true,
"lookupKey": "string",
"nickname": "string",
"productId": "string",
"taxBehavior": "string",
"tiersMode": "string",
"type": "string",
"unitAmount": 0,
"unitAmountDecimal": 0,
"updated": "string",
"stripeProduct": "[Circular Reference]"
}
],
"subscriptions": [
{
}
]
},
"subscriptionAbilitiesLists": [
{
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"subscription": "[Circular Reference]",
"subscriptionAbilities": [
{
"autoId": 0,
"subscriptionAbilitiesListId": 0,
"action": "string",
"subject": "string",
"enabled": true,
"subscriptionAbilitiesList": "[Circular Reference]"
}
],
"users": [
{
}
]
}
]
},
"users": [
{
}
]
}
]
POST /administration/users
POST
/administration/users
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"autoId": 0,
"userName": "string",
"password": "string",
"fullName": "string",
"email": "string",
"enabled": true,
"customerId": 0,
"subscriptionAbilitiesListId": 0,
"isGoogleAuth": true,
"googleAuthToken": "string",
"googleUserId": "string",
"googleRefreshToken": "string",
"passwordResetToken": "string",
"passwordResetTokenExpires": "string",
"createdAt": "string",
"adverseMediaResponses": [
{
"id": 0,
"monitoringProfileId": 0,
"companyName": "string",
"country": "string",
"summary": "string",
"relevantResults": true,
"acknowledged": true,
"acknowledgedBy": 0,
"createdAt": "string",
"updatedAt": "string",
"acknowledgedByNavigation": "[Circular Reference]",
"sourceArticles": [
{
"id": 0,
"adverseMediaResponseId": 0,
"title": "string",
"url": "string",
"confidenceScore": 0,
"datePosted": "string",
"createdAt": "string",
"adverseMediaResponse": "[Circular Reference]"
}
]
}
],
"auditTrails": [
{
"autoId": 0,
"id": "string",
"type": "string",
"action": "string",
"newValue": "string",
"oldValue": "string",
"userId": 0,
"internalId": "string",
"createdAt": "string",
"updatedAt": "string",
"user": "[Circular Reference]"
}
],
"checkAssignedToNavigations": [
{
"autoId": 0,
"externalId": "string",
"supplier": "string",
"checkType": "string",
"completed": true,
"profileId": 0,
"customerId": 0,
"userId": 0,
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"updatedBy": 0,
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"companyReports": [
{
"autoId": 0,
"connectId": "string",
"reportData": "string",
"customerId": 0,
"createdAt": "string",
"enabled": true,
"checkId": 0,
"companyName": "string",
"currentCreditRating": "string",
"currentCreditRatingDescription": "string",
"registrationNumber": "string",
"check": "[Circular Reference]"
}
],
"updatedByNavigation": "[Circular Reference]",
"user": "[Circular Reference]"
}
],
"checkUpdatedByNavigations": [
{
"autoId": 0,
"externalId": "string",
"supplier": "string",
"checkType": "string",
"completed": true,
"profileId": 0,
"customerId": 0,
"userId": 0,
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"updatedBy": 0,
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"companyReports": [
{
"autoId": 0,
"connectId": "string",
"reportData": "string",
"customerId": 0,
"createdAt": "string",
"enabled": true,
"checkId": 0,
"companyName": "string",
"currentCreditRating": "string",
"currentCreditRatingDescription": "string",
"registrationNumber": "string",
"check": "[Circular Reference]"
}
],
"updatedByNavigation": "[Circular Reference]",
"user": "[Circular Reference]"
}
],
"checkUsers": [
{
"autoId": 0,
"externalId": "string",
"supplier": "string",
"checkType": "string",
"completed": true,
"profileId": 0,
"customerId": 0,
"userId": 0,
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"updatedBy": 0,
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"companyReports": [
{
"autoId": 0,
"connectId": "string",
"reportData": "string",
"customerId": 0,
"createdAt": "string",
"enabled": true,
"checkId": 0,
"companyName": "string",
"currentCreditRating": "string",
"currentCreditRatingDescription": "string",
"registrationNumber": "string",
"check": "[Circular Reference]"
}
],
"updatedByNavigation": "[Circular Reference]",
"user": "[Circular Reference]"
}
],
"customer": {
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"enabled": true,
"createdAt": "string",
"telephone": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postalCode": "string",
"county": "string",
"country": "string",
"billingPlan": "string",
"stripeSubscriptionId": "string",
"stripeCustomerId": "string",
"riskPolicyContents": [
{
"autoId": 0,
"title": "string",
"content": "string",
"customerId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"processingStatus": "string",
"processedPolicyAutoId": 0,
"errorMessage": "string",
"customer": "[Circular Reference]",
"processedPolicyAuto": {
"autoId": 0,
"policyName": "string",
"policyId": "string",
"policyVersion": "string",
"currency": "string",
"createdDate": "string",
"updatedDate": "string",
"isActive": true,
"policyJson": "string",
"riskPolicyContents": [
{
}
],
"riskPolicyRules": [
{
"autoId": 0,
"ruleId": "string",
"policyAutoId": 0,
"policyId": "string",
"description": "string",
"maxExposure": 0,
"createdDate": "string",
"updatedDate": "string",
"policyAuto": "[Circular Reference]",
"riskPolicyApplicability": {
"applicabilityId": 0,
"ruleAutoId": 0,
"ruleId": "string",
"maxPd": 0,
"createdDate": "string",
"updatedDate": "string",
"riskPolicyApplicabilityCountries": [
{
"applicabilityCountryId": 0,
"applicabilityId": 0,
"countryCode": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"riskPolicyApplicabilityRiskRatings": [
{
"riskRatingId": 0,
"applicabilityId": 0,
"riskRating": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"ruleAuto": "[Circular Reference]"
},
"riskPolicyRulesConditions": [
{
"conditionId": 0,
"ruleAutoId": 0,
"ruleId": "string",
"condition": "string",
"conditionOrder": 0,
"createdDate": "string",
"ruleAuto": "[Circular Reference]"
}
]
}
]
}
}
],
"spheres": [
{
"autoId": 0,
"name": "string",
"customerId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"customer": "[Circular Reference]"
}
],
"subscription": {
"autoId": 0,
"name": "string",
"amlCredits": 0,
"idvCredits": 0,
"kycCredits": 0,
"kybCredits": 0,
"stripeProductId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabed": true,
"customers": [
{
}
],
"stripeProduct": {
"autoId": 0,
"productId": "string",
"object": "string",
"active": true,
"created": "string",
"defaultPriceId": "string",
"deleted": true,
"description": "string",
"livemode": true,
"name": "string",
"shippable": true,
"statementDescriptor": "string",
"taxCodeId": "string",
"type": "string",
"unitLabel": "string",
"updated": "string",
"url": "string",
"stripeProductsPrices": [
{
"autoId": 0,
"stripeProductId": 0,
"priceId": "string",
"object": "string",
"active": true,
"billingScheme": "string",
"created": "string",
"currency": "string",
"deleted": true,
"livemode": true,
"lookupKey": "string",
"nickname": "string",
"productId": "string",
"taxBehavior": "string",
"tiersMode": "string",
"type": "string",
"unitAmount": 0,
"unitAmountDecimal": 0,
"updated": "string",
"stripeProduct": "[Circular Reference]"
}
],
"subscriptions": [
{
}
]
},
"subscriptionAbilitiesLists": [
{
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"subscription": "[Circular Reference]",
"subscriptionAbilities": [
{
"autoId": 0,
"subscriptionAbilitiesListId": 0,
"action": "string",
"subject": "string",
"enabled": true,
"subscriptionAbilitiesList": "[Circular Reference]"
}
],
"users": [
{
}
]
}
]
},
"users": [
{
}
]
},
"decisionHistories": [
{
"decisionHistoryId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": {
"autoId": 0,
"name": "string",
"profileType": "string",
"externalId": "string",
"internalId": "string",
"countryCode": "string",
"parentId": 0,
"createdBy": "string",
"updatedBy": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"reviewDate": "string",
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"credas_Entities": [
{
"id": "string",
"name": "string",
"firstName": "string",
"surname": "string",
"dateCreated": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"phoneNumber": "string",
"address": "string",
"registrationCode": "string",
"status": 0,
"accountType": 0,
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"decisionHistories": [
{
}
],
"idvChecks": [
{
"autoId": 0,
"internalId": "string",
"externalId": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"profileId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"profile": "[Circular Reference]"
}
],
"personDetails": [
{
"id": 0,
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string",
"mainPosition": "string",
"directorId": "string",
"mobile": "string",
"telephone": "string",
"email": "string",
"dateOfAppointment": "string",
"personType": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"profileActionables": [
{
"autoId": 0,
"internalId": "string",
"actionableHeader": "string",
"actionableText": "string",
"actionableDescription": "string",
"actionableHelp": "string",
"actionableStatus": "string",
"generatedBy": "string",
"profileId": 0,
"enabled": true,
"profile": "[Circular Reference]"
}
],
"profileDecision": {
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
},
"profileNotes": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"stopHistories": [
{
"stopHistoryId": 0,
"profileId": 0,
"action": "string",
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"profile": "[Circular Reference]"
}
]
}
}
],
"profileDecisions": [
{
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
}
],
"profileNoteCreatedByNavigations": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"profileNoteDeletedByNavigations": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"profileNoteUpdatedByNavigations": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"profiles": [
{
"autoId": 0,
"name": "string",
"profileType": "string",
"externalId": "string",
"internalId": "string",
"countryCode": "string",
"parentId": 0,
"createdBy": "string",
"updatedBy": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"reviewDate": "string",
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"credas_Entities": [
{
"id": "string",
"name": "string",
"firstName": "string",
"surname": "string",
"dateCreated": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"phoneNumber": "string",
"address": "string",
"registrationCode": "string",
"status": 0,
"accountType": 0,
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"decisionHistories": [
{
}
],
"idvChecks": [
{
"autoId": 0,
"internalId": "string",
"externalId": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"profileId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"profile": "[Circular Reference]"
}
],
"personDetails": [
{
"id": 0,
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string",
"mainPosition": "string",
"directorId": "string",
"mobile": "string",
"telephone": "string",
"email": "string",
"dateOfAppointment": "string",
"personType": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"profileActionables": [
{
"autoId": 0,
"internalId": "string",
"actionableHeader": "string",
"actionableText": "string",
"actionableDescription": "string",
"actionableHelp": "string",
"actionableStatus": "string",
"generatedBy": "string",
"profileId": 0,
"enabled": true,
"profile": "[Circular Reference]"
}
],
"profileDecision": {
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
},
"profileNotes": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"stopHistories": [
{
"stopHistoryId": 0,
"profileId": 0,
"action": "string",
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"profile": "[Circular Reference]"
}
]
}
],
"subscriptionAbilitiesList": {
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"subscription": "[Circular Reference]",
"subscriptionAbilities": [
{
"autoId": 0,
"subscriptionAbilitiesListId": 0,
"action": "string",
"subject": "string",
"enabled": true,
"subscriptionAbilitiesList": "[Circular Reference]"
}
],
"users": [
{
}
]
},
"trackings": [
{
"autoId": 0,
"sessionId": "string",
"userId": 0,
"event": "string",
"value": "string",
"applicationCode": "string",
"createdAt": "string",
"user": "[Circular Reference]"
}
]
}
Responses
Created
JSON
{
"autoId": 0,
"userName": "string",
"password": "string",
"fullName": "string",
"email": "string",
"enabled": true,
"customerId": 0,
"subscriptionAbilitiesListId": 0,
"isGoogleAuth": true,
"googleAuthToken": "string",
"googleUserId": "string",
"googleRefreshToken": "string",
"passwordResetToken": "string",
"passwordResetTokenExpires": "string",
"createdAt": "string",
"adverseMediaResponses": [
{
"id": 0,
"monitoringProfileId": 0,
"companyName": "string",
"country": "string",
"summary": "string",
"relevantResults": true,
"acknowledged": true,
"acknowledgedBy": 0,
"createdAt": "string",
"updatedAt": "string",
"acknowledgedByNavigation": "[Circular Reference]",
"sourceArticles": [
{
"id": 0,
"adverseMediaResponseId": 0,
"title": "string",
"url": "string",
"confidenceScore": 0,
"datePosted": "string",
"createdAt": "string",
"adverseMediaResponse": "[Circular Reference]"
}
]
}
],
"auditTrails": [
{
"autoId": 0,
"id": "string",
"type": "string",
"action": "string",
"newValue": "string",
"oldValue": "string",
"userId": 0,
"internalId": "string",
"createdAt": "string",
"updatedAt": "string",
"user": "[Circular Reference]"
}
],
"checkAssignedToNavigations": [
{
"autoId": 0,
"externalId": "string",
"supplier": "string",
"checkType": "string",
"completed": true,
"profileId": 0,
"customerId": 0,
"userId": 0,
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"updatedBy": 0,
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"companyReports": [
{
"autoId": 0,
"connectId": "string",
"reportData": "string",
"customerId": 0,
"createdAt": "string",
"enabled": true,
"checkId": 0,
"companyName": "string",
"currentCreditRating": "string",
"currentCreditRatingDescription": "string",
"registrationNumber": "string",
"check": "[Circular Reference]"
}
],
"updatedByNavigation": "[Circular Reference]",
"user": "[Circular Reference]"
}
],
"checkUpdatedByNavigations": [
{
"autoId": 0,
"externalId": "string",
"supplier": "string",
"checkType": "string",
"completed": true,
"profileId": 0,
"customerId": 0,
"userId": 0,
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"updatedBy": 0,
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"companyReports": [
{
"autoId": 0,
"connectId": "string",
"reportData": "string",
"customerId": 0,
"createdAt": "string",
"enabled": true,
"checkId": 0,
"companyName": "string",
"currentCreditRating": "string",
"currentCreditRatingDescription": "string",
"registrationNumber": "string",
"check": "[Circular Reference]"
}
],
"updatedByNavigation": "[Circular Reference]",
"user": "[Circular Reference]"
}
],
"checkUsers": [
{
"autoId": 0,
"externalId": "string",
"supplier": "string",
"checkType": "string",
"completed": true,
"profileId": 0,
"customerId": 0,
"userId": 0,
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"updatedBy": 0,
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"companyReports": [
{
"autoId": 0,
"connectId": "string",
"reportData": "string",
"customerId": 0,
"createdAt": "string",
"enabled": true,
"checkId": 0,
"companyName": "string",
"currentCreditRating": "string",
"currentCreditRatingDescription": "string",
"registrationNumber": "string",
"check": "[Circular Reference]"
}
],
"updatedByNavigation": "[Circular Reference]",
"user": "[Circular Reference]"
}
],
"customer": {
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"enabled": true,
"createdAt": "string",
"telephone": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postalCode": "string",
"county": "string",
"country": "string",
"billingPlan": "string",
"stripeSubscriptionId": "string",
"stripeCustomerId": "string",
"riskPolicyContents": [
{
"autoId": 0,
"title": "string",
"content": "string",
"customerId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"processingStatus": "string",
"processedPolicyAutoId": 0,
"errorMessage": "string",
"customer": "[Circular Reference]",
"processedPolicyAuto": {
"autoId": 0,
"policyName": "string",
"policyId": "string",
"policyVersion": "string",
"currency": "string",
"createdDate": "string",
"updatedDate": "string",
"isActive": true,
"policyJson": "string",
"riskPolicyContents": [
{
}
],
"riskPolicyRules": [
{
"autoId": 0,
"ruleId": "string",
"policyAutoId": 0,
"policyId": "string",
"description": "string",
"maxExposure": 0,
"createdDate": "string",
"updatedDate": "string",
"policyAuto": "[Circular Reference]",
"riskPolicyApplicability": {
"applicabilityId": 0,
"ruleAutoId": 0,
"ruleId": "string",
"maxPd": 0,
"createdDate": "string",
"updatedDate": "string",
"riskPolicyApplicabilityCountries": [
{
"applicabilityCountryId": 0,
"applicabilityId": 0,
"countryCode": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"riskPolicyApplicabilityRiskRatings": [
{
"riskRatingId": 0,
"applicabilityId": 0,
"riskRating": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"ruleAuto": "[Circular Reference]"
},
"riskPolicyRulesConditions": [
{
"conditionId": 0,
"ruleAutoId": 0,
"ruleId": "string",
"condition": "string",
"conditionOrder": 0,
"createdDate": "string",
"ruleAuto": "[Circular Reference]"
}
]
}
]
}
}
],
"spheres": [
{
"autoId": 0,
"name": "string",
"customerId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"customer": "[Circular Reference]"
}
],
"subscription": {
"autoId": 0,
"name": "string",
"amlCredits": 0,
"idvCredits": 0,
"kycCredits": 0,
"kybCredits": 0,
"stripeProductId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabed": true,
"customers": [
{
}
],
"stripeProduct": {
"autoId": 0,
"productId": "string",
"object": "string",
"active": true,
"created": "string",
"defaultPriceId": "string",
"deleted": true,
"description": "string",
"livemode": true,
"name": "string",
"shippable": true,
"statementDescriptor": "string",
"taxCodeId": "string",
"type": "string",
"unitLabel": "string",
"updated": "string",
"url": "string",
"stripeProductsPrices": [
{
"autoId": 0,
"stripeProductId": 0,
"priceId": "string",
"object": "string",
"active": true,
"billingScheme": "string",
"created": "string",
"currency": "string",
"deleted": true,
"livemode": true,
"lookupKey": "string",
"nickname": "string",
"productId": "string",
"taxBehavior": "string",
"tiersMode": "string",
"type": "string",
"unitAmount": 0,
"unitAmountDecimal": 0,
"updated": "string",
"stripeProduct": "[Circular Reference]"
}
],
"subscriptions": [
{
}
]
},
"subscriptionAbilitiesLists": [
{
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"subscription": "[Circular Reference]",
"subscriptionAbilities": [
{
"autoId": 0,
"subscriptionAbilitiesListId": 0,
"action": "string",
"subject": "string",
"enabled": true,
"subscriptionAbilitiesList": "[Circular Reference]"
}
],
"users": [
{
}
]
}
]
},
"users": [
{
}
]
},
"decisionHistories": [
{
"decisionHistoryId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": {
"autoId": 0,
"name": "string",
"profileType": "string",
"externalId": "string",
"internalId": "string",
"countryCode": "string",
"parentId": 0,
"createdBy": "string",
"updatedBy": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"reviewDate": "string",
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"credas_Entities": [
{
"id": "string",
"name": "string",
"firstName": "string",
"surname": "string",
"dateCreated": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"phoneNumber": "string",
"address": "string",
"registrationCode": "string",
"status": 0,
"accountType": 0,
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"decisionHistories": [
{
}
],
"idvChecks": [
{
"autoId": 0,
"internalId": "string",
"externalId": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"profileId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"profile": "[Circular Reference]"
}
],
"personDetails": [
{
"id": 0,
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string",
"mainPosition": "string",
"directorId": "string",
"mobile": "string",
"telephone": "string",
"email": "string",
"dateOfAppointment": "string",
"personType": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"profileActionables": [
{
"autoId": 0,
"internalId": "string",
"actionableHeader": "string",
"actionableText": "string",
"actionableDescription": "string",
"actionableHelp": "string",
"actionableStatus": "string",
"generatedBy": "string",
"profileId": 0,
"enabled": true,
"profile": "[Circular Reference]"
}
],
"profileDecision": {
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
},
"profileNotes": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"stopHistories": [
{
"stopHistoryId": 0,
"profileId": 0,
"action": "string",
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"profile": "[Circular Reference]"
}
]
}
}
],
"profileDecisions": [
{
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
}
],
"profileNoteCreatedByNavigations": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"profileNoteDeletedByNavigations": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"profileNoteUpdatedByNavigations": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"profiles": [
{
"autoId": 0,
"name": "string",
"profileType": "string",
"externalId": "string",
"internalId": "string",
"countryCode": "string",
"parentId": 0,
"createdBy": "string",
"updatedBy": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"reviewDate": "string",
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"credas_Entities": [
{
"id": "string",
"name": "string",
"firstName": "string",
"surname": "string",
"dateCreated": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"phoneNumber": "string",
"address": "string",
"registrationCode": "string",
"status": 0,
"accountType": 0,
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"decisionHistories": [
{
}
],
"idvChecks": [
{
"autoId": 0,
"internalId": "string",
"externalId": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"profileId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"profile": "[Circular Reference]"
}
],
"personDetails": [
{
"id": 0,
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string",
"mainPosition": "string",
"directorId": "string",
"mobile": "string",
"telephone": "string",
"email": "string",
"dateOfAppointment": "string",
"personType": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"profileActionables": [
{
"autoId": 0,
"internalId": "string",
"actionableHeader": "string",
"actionableText": "string",
"actionableDescription": "string",
"actionableHelp": "string",
"actionableStatus": "string",
"generatedBy": "string",
"profileId": 0,
"enabled": true,
"profile": "[Circular Reference]"
}
],
"profileDecision": {
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
},
"profileNotes": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"stopHistories": [
{
"stopHistoryId": 0,
"profileId": 0,
"action": "string",
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"profile": "[Circular Reference]"
}
]
}
],
"subscriptionAbilitiesList": {
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"subscription": "[Circular Reference]",
"subscriptionAbilities": [
{
"autoId": 0,
"subscriptionAbilitiesListId": 0,
"action": "string",
"subject": "string",
"enabled": true,
"subscriptionAbilitiesList": "[Circular Reference]"
}
],
"users": [
{
}
]
},
"trackings": [
{
"autoId": 0,
"sessionId": "string",
"userId": 0,
"event": "string",
"value": "string",
"applicationCode": "string",
"createdAt": "string",
"user": "[Circular Reference]"
}
]
}
PUT /administration/user
PUT
/administration/user
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"autoId": 0,
"userName": "string",
"password": "string",
"fullName": "string",
"email": "string",
"enabled": true,
"customerId": 0,
"subscriptionAbilitiesListId": 0,
"isGoogleAuth": true,
"googleAuthToken": "string",
"googleUserId": "string",
"googleRefreshToken": "string",
"passwordResetToken": "string",
"passwordResetTokenExpires": "string",
"createdAt": "string",
"adverseMediaResponses": [
{
"id": 0,
"monitoringProfileId": 0,
"companyName": "string",
"country": "string",
"summary": "string",
"relevantResults": true,
"acknowledged": true,
"acknowledgedBy": 0,
"createdAt": "string",
"updatedAt": "string",
"acknowledgedByNavigation": "[Circular Reference]",
"sourceArticles": [
{
"id": 0,
"adverseMediaResponseId": 0,
"title": "string",
"url": "string",
"confidenceScore": 0,
"datePosted": "string",
"createdAt": "string",
"adverseMediaResponse": "[Circular Reference]"
}
]
}
],
"auditTrails": [
{
"autoId": 0,
"id": "string",
"type": "string",
"action": "string",
"newValue": "string",
"oldValue": "string",
"userId": 0,
"internalId": "string",
"createdAt": "string",
"updatedAt": "string",
"user": "[Circular Reference]"
}
],
"checkAssignedToNavigations": [
{
"autoId": 0,
"externalId": "string",
"supplier": "string",
"checkType": "string",
"completed": true,
"profileId": 0,
"customerId": 0,
"userId": 0,
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"updatedBy": 0,
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"companyReports": [
{
"autoId": 0,
"connectId": "string",
"reportData": "string",
"customerId": 0,
"createdAt": "string",
"enabled": true,
"checkId": 0,
"companyName": "string",
"currentCreditRating": "string",
"currentCreditRatingDescription": "string",
"registrationNumber": "string",
"check": "[Circular Reference]"
}
],
"updatedByNavigation": "[Circular Reference]",
"user": "[Circular Reference]"
}
],
"checkUpdatedByNavigations": [
{
"autoId": 0,
"externalId": "string",
"supplier": "string",
"checkType": "string",
"completed": true,
"profileId": 0,
"customerId": 0,
"userId": 0,
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"updatedBy": 0,
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"companyReports": [
{
"autoId": 0,
"connectId": "string",
"reportData": "string",
"customerId": 0,
"createdAt": "string",
"enabled": true,
"checkId": 0,
"companyName": "string",
"currentCreditRating": "string",
"currentCreditRatingDescription": "string",
"registrationNumber": "string",
"check": "[Circular Reference]"
}
],
"updatedByNavigation": "[Circular Reference]",
"user": "[Circular Reference]"
}
],
"checkUsers": [
{
"autoId": 0,
"externalId": "string",
"supplier": "string",
"checkType": "string",
"completed": true,
"profileId": 0,
"customerId": 0,
"userId": 0,
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"updatedBy": 0,
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"companyReports": [
{
"autoId": 0,
"connectId": "string",
"reportData": "string",
"customerId": 0,
"createdAt": "string",
"enabled": true,
"checkId": 0,
"companyName": "string",
"currentCreditRating": "string",
"currentCreditRatingDescription": "string",
"registrationNumber": "string",
"check": "[Circular Reference]"
}
],
"updatedByNavigation": "[Circular Reference]",
"user": "[Circular Reference]"
}
],
"customer": {
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"enabled": true,
"createdAt": "string",
"telephone": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"postalCode": "string",
"county": "string",
"country": "string",
"billingPlan": "string",
"stripeSubscriptionId": "string",
"stripeCustomerId": "string",
"riskPolicyContents": [
{
"autoId": 0,
"title": "string",
"content": "string",
"customerId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"processingStatus": "string",
"processedPolicyAutoId": 0,
"errorMessage": "string",
"customer": "[Circular Reference]",
"processedPolicyAuto": {
"autoId": 0,
"policyName": "string",
"policyId": "string",
"policyVersion": "string",
"currency": "string",
"createdDate": "string",
"updatedDate": "string",
"isActive": true,
"policyJson": "string",
"riskPolicyContents": [
{
}
],
"riskPolicyRules": [
{
"autoId": 0,
"ruleId": "string",
"policyAutoId": 0,
"policyId": "string",
"description": "string",
"maxExposure": 0,
"createdDate": "string",
"updatedDate": "string",
"policyAuto": "[Circular Reference]",
"riskPolicyApplicability": {
"applicabilityId": 0,
"ruleAutoId": 0,
"ruleId": "string",
"maxPd": 0,
"createdDate": "string",
"updatedDate": "string",
"riskPolicyApplicabilityCountries": [
{
"applicabilityCountryId": 0,
"applicabilityId": 0,
"countryCode": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"riskPolicyApplicabilityRiskRatings": [
{
"riskRatingId": 0,
"applicabilityId": 0,
"riskRating": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"ruleAuto": "[Circular Reference]"
},
"riskPolicyRulesConditions": [
{
"conditionId": 0,
"ruleAutoId": 0,
"ruleId": "string",
"condition": "string",
"conditionOrder": 0,
"createdDate": "string",
"ruleAuto": "[Circular Reference]"
}
]
}
]
}
}
],
"spheres": [
{
"autoId": 0,
"name": "string",
"customerId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"customer": "[Circular Reference]"
}
],
"subscription": {
"autoId": 0,
"name": "string",
"amlCredits": 0,
"idvCredits": 0,
"kycCredits": 0,
"kybCredits": 0,
"stripeProductId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabed": true,
"customers": [
{
}
],
"stripeProduct": {
"autoId": 0,
"productId": "string",
"object": "string",
"active": true,
"created": "string",
"defaultPriceId": "string",
"deleted": true,
"description": "string",
"livemode": true,
"name": "string",
"shippable": true,
"statementDescriptor": "string",
"taxCodeId": "string",
"type": "string",
"unitLabel": "string",
"updated": "string",
"url": "string",
"stripeProductsPrices": [
{
"autoId": 0,
"stripeProductId": 0,
"priceId": "string",
"object": "string",
"active": true,
"billingScheme": "string",
"created": "string",
"currency": "string",
"deleted": true,
"livemode": true,
"lookupKey": "string",
"nickname": "string",
"productId": "string",
"taxBehavior": "string",
"tiersMode": "string",
"type": "string",
"unitAmount": 0,
"unitAmountDecimal": 0,
"updated": "string",
"stripeProduct": "[Circular Reference]"
}
],
"subscriptions": [
{
}
]
},
"subscriptionAbilitiesLists": [
{
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"subscription": "[Circular Reference]",
"subscriptionAbilities": [
{
"autoId": 0,
"subscriptionAbilitiesListId": 0,
"action": "string",
"subject": "string",
"enabled": true,
"subscriptionAbilitiesList": "[Circular Reference]"
}
],
"users": [
{
}
]
}
]
},
"users": [
{
}
]
},
"decisionHistories": [
{
"decisionHistoryId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": {
"autoId": 0,
"name": "string",
"profileType": "string",
"externalId": "string",
"internalId": "string",
"countryCode": "string",
"parentId": 0,
"createdBy": "string",
"updatedBy": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"reviewDate": "string",
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"credas_Entities": [
{
"id": "string",
"name": "string",
"firstName": "string",
"surname": "string",
"dateCreated": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"phoneNumber": "string",
"address": "string",
"registrationCode": "string",
"status": 0,
"accountType": 0,
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"decisionHistories": [
{
}
],
"idvChecks": [
{
"autoId": 0,
"internalId": "string",
"externalId": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"profileId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"profile": "[Circular Reference]"
}
],
"personDetails": [
{
"id": 0,
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string",
"mainPosition": "string",
"directorId": "string",
"mobile": "string",
"telephone": "string",
"email": "string",
"dateOfAppointment": "string",
"personType": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"profileActionables": [
{
"autoId": 0,
"internalId": "string",
"actionableHeader": "string",
"actionableText": "string",
"actionableDescription": "string",
"actionableHelp": "string",
"actionableStatus": "string",
"generatedBy": "string",
"profileId": 0,
"enabled": true,
"profile": "[Circular Reference]"
}
],
"profileDecision": {
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
},
"profileNotes": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"stopHistories": [
{
"stopHistoryId": 0,
"profileId": 0,
"action": "string",
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"profile": "[Circular Reference]"
}
]
}
}
],
"profileDecisions": [
{
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
}
],
"profileNoteCreatedByNavigations": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"profileNoteDeletedByNavigations": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"profileNoteUpdatedByNavigations": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"profiles": [
{
"autoId": 0,
"name": "string",
"profileType": "string",
"externalId": "string",
"internalId": "string",
"countryCode": "string",
"parentId": 0,
"createdBy": "string",
"updatedBy": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"reviewDate": "string",
"assignedTo": 0,
"createdDate": "string",
"updatedDate": "string",
"enabled": true,
"assignedToNavigation": "[Circular Reference]",
"credas_Entities": [
{
"id": "string",
"name": "string",
"firstName": "string",
"surname": "string",
"dateCreated": "string",
"dateOfBirth": "string",
"emailAddress": "string",
"phoneNumber": "string",
"address": "string",
"registrationCode": "string",
"status": 0,
"accountType": 0,
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"decisionHistories": [
{
}
],
"idvChecks": [
{
"autoId": 0,
"internalId": "string",
"externalId": "string",
"customerId": 0,
"status": "string",
"riskRating": "string",
"profileId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"profile": "[Circular Reference]"
}
],
"personDetails": [
{
"id": 0,
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string",
"mainPosition": "string",
"directorId": "string",
"mobile": "string",
"telephone": "string",
"email": "string",
"dateOfAppointment": "string",
"personType": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": 0,
"profile": "[Circular Reference]"
}
],
"profileActionables": [
{
"autoId": 0,
"internalId": "string",
"actionableHeader": "string",
"actionableText": "string",
"actionableDescription": "string",
"actionableHelp": "string",
"actionableStatus": "string",
"generatedBy": "string",
"profileId": 0,
"enabled": true,
"profile": "[Circular Reference]"
}
],
"profileDecision": {
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
},
"profileNotes": [
{
"autoId": 0,
"profileId": 0,
"content": "string",
"createdBy": 0,
"createdAt": "string",
"updatedBy": 0,
"updatedAt": "string",
"isDeleted": true,
"deletedBy": 0,
"deletedAt": "string",
"createdByNavigation": "[Circular Reference]",
"deletedByNavigation": "[Circular Reference]",
"profile": "[Circular Reference]",
"updatedByNavigation": "[Circular Reference]"
}
],
"stopHistories": [
{
"stopHistoryId": 0,
"profileId": 0,
"action": "string",
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"profile": "[Circular Reference]"
}
]
}
],
"subscriptionAbilitiesList": {
"autoId": 0,
"subscriptionId": 0,
"name": "string",
"subscription": "[Circular Reference]",
"subscriptionAbilities": [
{
"autoId": 0,
"subscriptionAbilitiesListId": 0,
"action": "string",
"subject": "string",
"enabled": true,
"subscriptionAbilitiesList": "[Circular Reference]"
}
],
"users": [
{
}
]
},
"trackings": [
{
"autoId": 0,
"sessionId": "string",
"userId": 0,
"event": "string",
"value": "string",
"applicationCode": "string",
"createdAt": "string",
"user": "[Circular Reference]"
}
]
}
Responses
OK
POST /auth/login
POST
/auth/login
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Responses
OK
Checks
Operations
POST/check/kyc/{profileId}GET/checks/amlGET/checks/kycGET/check/kyc/{resultId}PUT/check/aml/{type}/{id}PUT/check/decision/{id}/{factor}PUT/check/{type}/{id}/{factor}POST/check/aml/individual/newPOST/check/aml/individual/{profileId}POST/check/aml/company/{profileId}GET/check/{type}/{id}GET/checks/{profileId}GET/check/{type}/{checkId}/hit/{hitId}PUT/check/{type}/{checkId}/hit/{hitId}POST/check/document/{profileId}GET/check/documentGET/check/document/{profileId}/{checkId}GET/check/document/{processId}/pdfGET/check/document/{entityId}/{entryId}/selfieGET/check/document/{entityId}/{entryId}/uapGET/check/document/{entityId}/{entryId}/{idDocumentId}/id-documents/{side}POST/check/document/{checkId}/resend
POST /check/kyc/{profileId}
POST
/check/kyc/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Request Body
JSON
{
"landLine": "string",
"mobile": "string",
"reference": "string",
"person": {
"currentName": {
"title": "string",
"forename": "string",
"otherNames": "string",
"surname": "string",
"suffix": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"previousName": {
"title": "string",
"forename": "string",
"otherNames": "string",
"surname": "string",
"suffix": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"dateOfBirth": "string",
"gender": 0,
"addresses": {
"current": {
"abodeNo": "string",
"buildingNo": "string",
"buildingName": "string",
"street": "string",
"subStreet": "string",
"city": "string",
"postCode": "string",
"organisation": "string",
"subBuilding": "string",
"district": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"previous1": {
"abodeNo": "string",
"buildingNo": "string",
"buildingName": "string",
"street": "string",
"subStreet": "string",
"city": "string",
"postCode": "string",
"organisation": "string",
"subBuilding": "string",
"district": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"previous2": {
"abodeNo": "string",
"buildingNo": "string",
"buildingName": "string",
"street": "string",
"subStreet": "string",
"city": "string",
"postCode": "string",
"organisation": "string",
"subBuilding": "string",
"district": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"additionalProperties": {
"additionalProperties": "string"
}
},
"additionalProperties": {
"additionalProperties": "string"
}
}
}
Responses
OK
JSON
{
"correlationId": "string",
"uniqueId": "string",
"input": {
"uniqueId": "string",
"common": {
"person": {
"currentName": {
"title": "string",
"forename": "string",
"otherNames": "string",
"surname": "string",
"suffix": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"previousName": {
"title": "string",
"forename": "string",
"otherNames": "string",
"surname": "string",
"suffix": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"dateOfBirth": "string",
"gender": 0,
"addresses": {
"current": {
"abodeNo": "string",
"buildingNo": "string",
"buildingName": "string",
"street": "string",
"subStreet": "string",
"city": "string",
"postCode": "string",
"organisation": "string",
"subBuilding": "string",
"district": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"previous1": {
"abodeNo": "string",
"buildingNo": "string",
"buildingName": "string",
"street": "string",
"subStreet": "string",
"city": "string",
"postCode": "string",
"organisation": "string",
"subBuilding": "string",
"district": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"previous2": {
"abodeNo": "string",
"buildingNo": "string",
"buildingName": "string",
"street": "string",
"subStreet": "string",
"city": "string",
"postCode": "string",
"organisation": "string",
"subBuilding": "string",
"district": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"additionalProperties": {
"additionalProperties": "string"
}
},
"additionalProperties": {
"additionalProperties": "string"
}
},
"customerId": 0,
"userId": 0,
"reference": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"idAml": {
"landlineNumber": 0,
"exDirectory": true,
"isAmlMultiBureau": true,
"additionalProperties": {
"additionalProperties": "string"
}
},
"products": [
"string"
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"common": {
"customerId": 0,
"userId": 0,
"uniqueId": "string",
"searchText": "string",
"reference": "string",
"searchTime": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"amlResult": {
"bandText": "string",
"birthIndexMatch": true,
"noRetry": true,
"resultCodes": {
"ukEditedVotersDatabase": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukCreditHeaderAml": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"accountsInfo": [
{
"lenderType": "string",
"accounts": 0,
"activeAccounts": 0,
"oldestAccountStartDate": "string",
"youngestAccountStartDate": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukCreditBureau": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"accountsInfo": [
{
"lenderType": "string",
"accounts": 0,
"activeAccounts": 0,
"oldestAccountStartDate": "string",
"youngestAccountStartDate": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"combinedDecision": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"accountsInfo": [
{
"lenderType": "string",
"accounts": 0,
"activeAccounts": 0,
"oldestAccountStartDate": "string",
"youngestAccountStartDate": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukNationalIdentityRegister": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukDeceasedPersonDatabase": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukncoa": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"internationalSanctions": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"sanctions": [
{
"detail": {
"aliases": [
"string"
],
"fullName": "string",
"identityInformation": [
],
"addresses": [
{
"city": "string",
"country": "string",
"firstLine": "string",
"region": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"sanctionBodies": [
"string"
],
"dates": [
{
"date": "string",
"dateType": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"id": "string",
"score": 0,
"url": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"internationalEnhancedPepDatabase": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"peps": [
{
"detail": {
"aliases": [
"string"
],
"fullName": "string",
"identityInformation": [
],
"addresses": [
],
"dates": [
],
"tier": 0,
"positions": [
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"id": "string",
"score": 0,
"url": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"additionalProperties": {
"additionalProperties": "string"
}
},
"score": 0,
"searchText": "string",
"legacyUniqueID": "string",
"validationID": "string",
"hasAlerts": true,
"success": true,
"creditsIncurred": 0,
"additionalProperties": {
"additionalProperties": "string"
}
},
"errors": {
"additionalProperties": [
]
},
"additionalProperties": {
"additionalProperties": "string"
}
}
GET /checks/aml
GET
/checks/aml
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Query Parameters
count
Type
integer
Format
"int32"Default
10Responses
OK
JSON
[
{
"id": "string",
"dateOfBirth": "string",
"name": "string",
"type": "string",
"status": "string",
"riskRating": "string",
"threshold": 0,
"assignedUser": "string",
"createdBy": "string",
"createdAt": "string",
"modifiedBy": "string",
"modifiedAt": "string",
"note": "string",
"totalHitCount": 0,
"truePositiveHitsCount": 0,
"falsePositiveHitsCount": 0,
"undecidedHitsCount": 0,
"scheduleId": "string",
"profileId": "string",
"customerId": 0,
"externalId": "string",
"kybCreatedAt": "string"
}
]
GET /checks/kyc
GET
/checks/kyc
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Query Parameters
count
Type
integer
Format
"int32"Default
10Responses
OK
JSON
[
{
"status": "string",
"riskRating": "string",
"profileId": 0,
"createdAt": "string",
"updatedAt": "string",
"enabled": true,
"searchText": "string",
"additionalJson": "string",
"countryCode": "string",
"name": "string",
"hasAlerts": true,
"uniqueId": "string",
"customerId": 0
}
]
GET /check/kyc/{resultId}
GET
/check/kyc/{resultId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
resultId*
Type
Requiredstring
Responses
OK
JSON
{
"resultId": 0,
"correlationId": "string",
"rootUniqueId": "string",
"rootAdditionalJson": "string",
"requestId": 0,
"requestUniqueId": "string",
"requestAdditionalJson": "string",
"commonId": 0,
"commonReference": "string",
"commonAdditionalJson": "string",
"amlCriteriaId": 0,
"isAmlMultiBureau": true,
"amlCriteriaAdditionalJson": "string",
"commonResultId": 0,
"searchTime": "string",
"searchText": "string",
"outputReference": "string",
"commonResultAdditionalJson": "string",
"supplierResultId": 0,
"supplierScore": 0,
"bandText": "string",
"hasAlerts": true,
"success": true,
"creditsIncurred": 0,
"supplierResultAdditionalJson": "string",
"resultCodesJson": "string",
"resultCodes": {
"ukEditedVotersDatabase": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukCreditHeaderAml": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"accountsInfo": [
{
"lenderType": "string",
"accounts": 0,
"activeAccounts": 0,
"oldestAccountStartDate": "string",
"youngestAccountStartDate": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukCreditBureau": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"accountsInfo": [
{
"lenderType": "string",
"accounts": 0,
"activeAccounts": 0,
"oldestAccountStartDate": "string",
"youngestAccountStartDate": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"combinedDecision": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"accountsInfo": [
{
"lenderType": "string",
"accounts": 0,
"activeAccounts": 0,
"oldestAccountStartDate": "string",
"youngestAccountStartDate": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukNationalIdentityRegister": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukDeceasedPersonDatabase": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"ukncoa": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"internationalSanctions": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"sanctions": [
{
"detail": {
"aliases": [
"string"
],
"fullName": "string",
"identityInformation": [
],
"addresses": [
{
"city": "string",
"country": "string",
"firstLine": "string",
"region": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"sanctionBodies": [
"string"
],
"dates": [
{
"date": "string",
"dateType": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"id": "string",
"score": 0,
"url": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"internationalEnhancedPepDatabase": {
"id": 0,
"name": "string",
"description": "string",
"address": "string",
"alert": "string",
"dateOfBirth": "string",
"forename": "string",
"surname": "string",
"pass": "string",
"comments": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"match": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"misMatch": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"warning": [
{
"code": 0,
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"peps": [
{
"detail": {
"aliases": [
"string"
],
"fullName": "string",
"identityInformation": [
],
"addresses": [
],
"dates": [
],
"tier": 0,
"positions": [
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"id": "string",
"score": 0,
"url": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
},
"additionalProperties": {
"additionalProperties": "string"
}
},
"profileId": "string",
"productsCsv": "string",
"riskRating": "string",
"status": "string",
"person": {
"personId": 0,
"dateOfBirth": "string",
"gender": 0,
"personAdditionalJson": "string",
"currentNameId": 0,
"currentTitle": "string",
"currentForename": "string",
"currentOtherNames": "string",
"currentSurname": "string",
"currentSuffix": "string",
"previousNameId": 0,
"previousTitle": "string",
"previousForename": "string",
"previousOtherNames": "string",
"previousSurname": "string",
"previousSuffix": "string"
},
"addresses": [
{
"addressId": 0,
"addressListId": 0,
"personId": 0,
"role": "string",
"abodeNo": "string",
"buildingNo": "string",
"buildingName": "string",
"subBuilding": "string",
"subStreet": "string",
"street": "string",
"city": "string",
"district": "string",
"postCode": "string",
"organisation": "string"
}
],
"errors": [
{
"errorId": 0,
"errorKey": "string",
"errorMessageId": 0,
"errorMessage": "string"
}
],
"aiSummary": {
"id": "string",
"success": true,
"response": "string",
"model": "string",
"tokensUsed": 0,
"timestamp": "string"
}
}
PUT /check/aml/{type}/{id}
PUT
/check/aml/{type}/{id}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
type*
Type
Requiredstring
id*
Type
Requiredstring
Request Body
JSON
{
"riskRating": "string",
"status": "string"
}
Responses
OK
PUT /check/decision/{id}/{factor}
PUT
/check/decision/{id}/{factor}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
id*
Type
Requiredstring
factor*
Type
Requiredstring
Request Body
JSON
{
"value": "string"
}
Responses
OK
PUT /check/{type}/{id}/{factor}
PUT
/check/{type}/{id}/{factor}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
type*
Type
Requiredstring
id*
Type
Requiredstring
factor*
Type
Requiredstring
Request Body
JSON
{
"value": "string"
}
Responses
OK
POST /check/aml/individual/new
POST
/check/aml/individual/new
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"countryCodes": [
"string"
],
"threshold": 0,
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "string",
"gender": 0,
"pepTiers": [
0
],
"datasets": [
"string"
],
"additionalProperties": {
"additionalProperties": "string"
},
"externalId": "string",
"address": {
"type": 0,
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"email": "string"
}
Responses
OK
JSON
{
"id": "string",
"name": "string",
"countryCodes": [
"string"
],
"threshold": 0,
"type": "string",
"datasets": [
"string"
],
"status": "string",
"riskRating": "string",
"assignedToUserId": 0,
"assignedUser": "string",
"createdById": 0,
"createdBy": "string",
"createdAt": "string",
"modifiedById": 0,
"modifiedBy": "string",
"modifiedAt": "string",
"note": "string",
"totalHitCount": 0,
"truePositiveHitsCount": 0,
"falsePositiveHitsCount": 0,
"undecidedHitsCount": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"dateOfBirth": "string",
"pepTiers": [
"string"
],
"scheduleId": "string",
"additionalProperties": {
"additionalProperties": "string"
},
"newProfileId": "string"
}
POST /check/aml/individual/{profileId}
POST
/check/aml/individual/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Request Body
JSON
{
"countryCodes": [
"string"
],
"threshold": 0,
"name": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dateOfBirth": "string",
"gender": 0,
"pepTiers": [
0
],
"datasets": [
"string"
],
"additionalProperties": {
"additionalProperties": "string"
}
}
Responses
OK
JSON
{
"totalSize": 0,
"items": [
{
"id": "string",
"name": "string",
"countryCodes": [
"string"
],
"threshold": 0,
"type": "string",
"datasets": [
"string"
],
"status": "string",
"riskRating": "string",
"assignedToUserId": 0,
"assignedUser": "string",
"createdById": 0,
"createdBy": "string",
"createdAt": "string",
"modifiedById": 0,
"modifiedBy": "string",
"modifiedAt": "string",
"note": "string",
"scheduleId": "string",
"totalHitCount": 0,
"truePositiveHitsCount": 0,
"falsePositiveHitsCount": 0,
"undecidedHitsCount": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"gender": "string",
"dateOfBirth": "string",
"pepTiers": [
"string"
],
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
}
}
POST /check/aml/company/{profileId}
POST
/check/aml/company/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Request Body
JSON
{
"countryCodes": [
"string"
],
"threshold": 0,
"name": "string",
"datasets": [
"string"
],
"additionalProperties": {
"additionalProperties": "string"
}
}
Responses
OK
JSON
{
"id": "string",
"name": "string",
"countryCodes": [
"string"
],
"threshold": 0,
"type": "string",
"datasets": [
"string"
],
"status": "string",
"riskRating": "string",
"assignedToUserId": 0,
"assignedUser": "string",
"createdById": 0,
"createdBy": "string",
"createdAt": "string",
"modifiedById": 0,
"modifiedBy": "string",
"modifiedAt": "string",
"note": "string",
"scheduleId": "string",
"totalHitCount": 0,
"truePositiveHitsCount": 0,
"falsePositiveHitsCount": 0,
"undecidedHitsCount": 0,
"correlationId": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
GET /check/{type}/{id}
GET
/check/{type}/{id}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
id*
Type
Requiredstring
type*
Type
Requiredstring
Responses
OK
GET /checks/{profileId}
GET
/checks/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredinteger
Format
"int32"Responses
OK
JSON
[
{
"id": "string",
"dateOfBirth": "string",
"name": "string",
"type": "string",
"status": "string",
"riskRating": "string",
"threshold": 0,
"assignedUser": "string",
"createdBy": "string",
"createdAt": "string",
"modifiedBy": "string",
"modifiedAt": "string",
"note": "string",
"totalHitCount": 0,
"truePositiveHitsCount": 0,
"falsePositiveHitsCount": 0,
"undecidedHitsCount": 0,
"scheduleId": "string",
"profileId": "string",
"customerId": 0,
"externalId": "string",
"kybCreatedAt": "string"
}
]
GET /check/{type}/{checkId}/hit/{hitId}
GET
/check/{type}/{checkId}/hit/{hitId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
type*
Type
Requiredstring
checkId*
Type
Requiredstring
hitId*
Type
Requiredstring
Responses
OK
PUT /check/{type}/{checkId}/hit/{hitId}
PUT
/check/{type}/{checkId}/hit/{hitId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
type*
Type
Requiredstring
checkId*
Type
Requiredstring
hitId*
Type
Requiredstring
Request Body
JSON
[
]
Responses
OK
POST /check/document/{profileId}
POST
/check/document/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredinteger
Format
"int32"Request Body
JSON
{
"journeyId": "string",
"userGroupId": "string",
"clientId": "string",
"userId": "string",
"title": "string",
"webhookUrl": "string",
"webhookStepUrl": "string",
"processEntities": [
{
"id": "string",
"emailAddress": "string",
"phoneNumber": "string",
"name": "string",
"firstName": "string",
"middleName": "string",
"surname": "string",
"reference": "string",
"actorId": 0,
"contactViaEmail": true,
"contactViaSms": true,
"inPerson": true,
"contactType": 0,
"dateOfBirth": "string",
"address": {
"addressLine1": "string",
"addressLine2": "string",
"town": "string",
"county": "string",
"postcode": "string"
},
"senderTelephoneNumberId": 0,
"clientAliasName": "string",
"clientAliasLogoBase64": "string"
}
],
"processUsers": [
{
"actorId": 0,
"userId": "string",
"userGroupId": "string",
"clientId": "string",
"contactViaEmail": true,
"contactViaAlert": true,
"contactType": 0
}
],
"defaultFormValues": [
{
"questionId": 0,
"reference": "string",
"value": "string",
"base64File": "string",
"mimeType": "string"
}
],
"skipSendingEntityInvites": true
}
Responses
OK
JSON
{
"title": "string",
"id": "string",
"clientId": "string",
"journeyId": "string",
"dateCreated": "string",
"dateCompleted": "string",
"percentageComplete": 0,
"isComplete": true,
"isReadOnly": true,
"status": 0,
"processTasks": [
{
"id": 0,
"processId": "string",
"status": 0,
"type": 0,
"title": "string",
"dateStarted": "string",
"dateCompleted": "string",
"informationPages": [
{
"id": 0,
"taskId": 0,
"confirmed": true,
"processActorId": 0,
"informationPage": {
"id": 0,
"title": "string",
"isPublic": true,
"requiresConfirmation": true,
"content": "string",
"confirmationMessage": "string",
"additionalConfirmationMessages": [
{
"id": 0,
"informationPageId": 0,
"confirmationMessage": "string"
}
]
}
}
],
"forms": [
{
"id": 0,
"title": "string",
"processTaskId": 0,
"order": 0,
"totalQuestions": 0,
"totalAnswered": 0,
"totalMandatoryQuestions": 0,
"totalMandatoryAnswered": 0,
"totalPendingApproval": 0,
"totalRejected": 0,
"entityForm": {
"id": 0,
"title": "string",
"dateStarted": "string",
"dateCompleted": "string",
"answerUpdateRequired": true,
"submitted": true,
"questions": [
{
"id": 0,
"formQuestionId": 0,
"approvalPerformedBy": "string",
"approvalStatus": 0,
"approvalTimestamp": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0,
"locked": true,
"answers": [
{
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"value": "string",
"mimeType": "string",
"optionCode": "string",
"blobReference": "string",
"hasValue": true,
"metaData": {
"additionalProperties": "string"
},
"isDefaultValue": true
}
],
"validations": [
{
"entityFormQuestionId": 0,
"entityFormQuestion": "[Circular Reference]",
"dateCreated": "string",
"approved": true,
"approvalPerformedBy": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0
}
],
"question": "string",
"type": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"lookupList": {
"id": 0,
"name": "string",
"description": "string",
"isPublic": true,
"isActive": true,
"dateCreated": "string",
"lastUpdated": "string",
"options": [
{
"id": 0,
"code": "string",
"value": "string",
"order": 0,
"dateCreated": "string",
"lastUpdated": "string"
}
]
},
"validationScoreRange": "string",
"validationScoreMax": 0,
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
"id": 0,
"formQuestionId": 0,
"enabledOnFormQuestionId": 0,
"enabledOnFormQuestion": {
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"question": "string",
"type": 0,
"formVersionId": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"validationScoreRange": "string",
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"injectionMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"currencies": "string"
},
"enabledOnValue": "string"
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"validationScores": [
0
],
"hasAnswer": true,
"isAnswerable": true,
"isOptionType": true,
"isFileType": true,
"currencies": "string"
}
],
"enabledQuestions": [
{
"id": 0,
"formQuestionId": 0,
"approvalPerformedBy": "string",
"approvalStatus": 0,
"approvalTimestamp": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0,
"locked": true,
"answers": [
{
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"value": "string",
"mimeType": "string",
"optionCode": "string",
"blobReference": "string",
"hasValue": true,
"metaData": {
"additionalProperties": "string"
},
"isDefaultValue": true
}
],
"validations": [
{
"entityFormQuestionId": 0,
"entityFormQuestion": "[Circular Reference]",
"dateCreated": "string",
"approved": true,
"approvalPerformedBy": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0
}
],
"question": "string",
"type": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"lookupList": {
"id": 0,
"name": "string",
"description": "string",
"isPublic": true,
"isActive": true,
"dateCreated": "string",
"lastUpdated": "string",
"options": [
{
"id": 0,
"code": "string",
"value": "string",
"order": 0,
"dateCreated": "string",
"lastUpdated": "string"
}
]
},
"validationScoreRange": "string",
"validationScoreMax": 0,
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
"id": 0,
"formQuestionId": 0,
"enabledOnFormQuestionId": 0,
"enabledOnFormQuestion": {
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"question": "string",
"type": 0,
"formVersionId": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"validationScoreRange": "string",
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"injectionMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"currencies": "string"
},
"enabledOnValue": "string"
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"validationScores": [
0
],
"hasAnswer": true,
"isAnswerable": true,
"isOptionType": true,
"isFileType": true,
"currencies": "string"
}
],
"totalQuestions": 0,
"totalAnswered": 0,
"totalMandatoryQuestions": 0,
"totalMandatoryAnswered": 0,
"validationDate": "string",
"validationScore": 0,
"validationScoreMax": 0,
"totalPendingApproval": 0,
"totalRejected": 0,
"isComplete": true,
"isMandatoryComplete": true,
"percentageComplete": 0
},
"processActorId": 0,
"editableByClient": true,
"submitted": true,
"dateCompleted": "string",
"percentageComplete": 0,
"validationScore": 0,
"validationScoreMax": 0
}
],
"tables": [
{
"id": 0,
"title": "string",
"processTaskId": 0,
"processActorId": 0,
"content": {
"canAddRows": true,
"columns": [
{
"order": 0,
"title": "string",
"type": 0,
"isReadonly": true,
"options": [
"string"
]
}
],
"defaultRows": [
{
"title": "string",
"values": [
"string"
]
}
],
"rows": [
{
"title": "string",
"values": [
"string"
]
}
]
},
"editableByClient": true,
"editableByEntity": true,
"order": 0,
"submitted": true,
"totalQuestions": 0,
"totalQuestionsAnswered": 0
}
],
"dataConnectors": [
{
"id": 0,
"processTaskId": 0,
"processActorId": 0,
"dataCheckStatus": 0,
"dataCheckId": 0,
"dataCheck": {
"id": 0,
"entityId": "string",
"dateCreated": "string",
"dataConnectorType": 0,
"title": "string",
"status": 0,
"gbgID3Input": {
"dataCheckId": 0,
"forename": "string",
"middleName": "string",
"surname": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"addressLine2": "string",
"postcode": "string",
"city": "string",
"county": "string",
"country": "string",
"bankAccountSortcode": "string",
"bankAccountNumber": "string"
},
"gbgID3Result": {
"dataCheckId": 0,
"searchId": "string",
"profileName": "string",
"resultText": "string",
"score": 0,
"dataSources": [
{
"resultId": 0,
"name": "string",
"description": "string",
"type": 0,
"country": "string",
"passStatus": 0,
"addressStatus": 0,
"forenameStatus": 0,
"surnameStatus": 0,
"dateOfBirthStatus": 0,
"alertStatus": 0,
"remarks": [
{
"dataSourceId": 0,
"type": 0,
"code": 0,
"description": "string"
}
]
}
],
"peps": [
{
"id": 0,
"resultId": 0,
"status": 0,
"isMismatch": true,
"fullName": "string",
"aliases": [
"string"
],
"addresses": [
"string"
],
"sanctionDates": [
"string"
],
"identityInformation": [
"string"
],
"itemId": "string",
"url": "string",
"score": 0,
"caseId": "string",
"searchId": "string",
"fcraEnabled": true,
"rank": 0,
"actionLog": [
{
"dateCreated": "string",
"previousStatus": 0,
"newStatus": 0,
"userId": "string",
"userName": "string",
"comment": "string"
}
],
"positions": [
"string"
],
"tier": 0
}
],
"sanctions": [
{
"id": 0,
"resultId": 0,
"status": 0,
"isMismatch": true,
"fullName": "string",
"aliases": [
"string"
],
"addresses": [
"string"
],
"sanctionDates": [
"string"
],
"identityInformation": [
"string"
],
"itemId": "string",
"url": "string",
"score": 0,
"caseId": "string",
"searchId": "string",
"fcraEnabled": true,
"rank": 0,
"actionLog": [
{
"dateCreated": "string",
"previousStatus": 0,
"newStatus": 0,
"userId": "string",
"userName": "string",
"comment": "string"
}
],
"sanctionBodies": [
"string"
]
}
]
},
"proofOfOwnershipInput": {
"firstName": "string",
"middleName": "string",
"surname": "string",
"addressLine1": "string",
"addressLine2": "string",
"postcode": "string",
"city": "string"
},
"proofOfOwnershipResult": {
"reference": "string",
"overallResult": 0,
"matches": [
{
"titleNumber": "string",
"firstNameMatch": 0,
"middleNameMatch": 0,
"surnameMatch": 0,
"overallMatch": 0,
"isHistorical": true,
"ownershipType": 0,
"proprietorFrom": "string",
"proprietorTo": "string",
"property": {
"buildingName": "string",
"buildingNumber": "string",
"streetName": "string",
"city": "string",
"postcode": "string",
"subBuildingName": "string",
"tenure": "string"
}
}
],
"files": [
{
"fileId": "string",
"filename": "string",
"titleNumber": "string"
}
],
"titles": [
{
"address": "string",
"tenure": "string",
"titleNumber": "string",
"matchType": 0,
"id": 0,
"status": 0
}
]
},
"acurisInput": {
"threshold": 0,
"firstName": "string",
"middleNames": "string",
"lastName": "string",
"dateOfBirth": "string",
"dateOfBirthMatching": 0,
"datasets": [
0
],
"countries": [
"string"
],
"nameMatching": 0,
"useAllCountries": true,
"useAllPepTiers": true,
"pepTiers": [
0
],
"includeMatchesWithoutDateOfBirth": true
},
"acurisResult": [
{
"id": 0,
"createdDate": "string",
"version": 0,
"resourceId": "string",
"score": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isDeceased": true,
"dateOfBirth": "string",
"dateOfDeath": "string",
"gender": 0,
"pepTier": 0,
"profileImageBlobReference": "string",
"status": 0,
"reviewByUser": "string",
"reviewDate": "string",
"reviewComments": "string",
"addresses": [
{
"addressType": 0,
"line1": "string",
"line2": "string",
"postcode": "string",
"city": "string",
"county": "string",
"countyAbbrev": "string",
"countryIsoCode": "string"
}
],
"aliases": [
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"type": 0
}
],
"contactDetails": [
{
"category": 0,
"value": "string"
}
],
"countries": [
"string"
],
"datasets": [
0
],
"disqualifiedDirectors": [
{
"caseReference": "string",
"reason": "string",
"conduct": "string",
"dateFrom": "string",
"dateTo": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
],
"identifiers": [
{
"category": "string",
"value": "string"
}
],
"imageBlobReferences": [
"string"
],
"nationalities": [
"string"
],
"peps": [
{
"countryIsoCode": "string",
"segment": "string",
"position": "string",
"dateFrom": "string",
"dateTo": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
],
"isCurrent": true
}
],
"notes": [
"string"
],
"regulatoryEnforcements": [
{
"category": 0,
"subcategory": "string",
"events": [
{
"type": "string",
"currencyCode": "string",
"amount": 0,
"periodDays": 0,
"periodMonths": 0,
"periodYears": 0,
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
]
}
],
"reputationalRiskExposures": [
{
"category": "string",
"subcategory": "string",
"events": [
{
"type": "string",
"date": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
]
}
],
"sanctions": [
{
"sanctionId": "string",
"regimeBody": "string",
"regimeName": "string",
"regimeOrigin": "string",
"events": [
{
"type": 0,
"date": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
],
"measures": [
"string"
],
"isCurrent": true
}
],
"associatedProfiles": [
{
}
],
"profilesOfInterest": [
{
"category": "string",
"positions": [
{
"title": "string",
"segment": "string",
"countryIsoCode": "string",
"dateFrom": "string",
"dateTo": "string"
}
],
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
]
}
],
"isOnGoingMonitor": true,
"isOnGoingMonitorActive": true,
"onGoingMonitorEndDate": "string",
"dataCheckNotes": [
{
"status": 0,
"noteText": "string",
"createdByUser": "string",
"dateCreated": "string"
}
],
"activeCheckStatus": 0,
"extendedInternationalCheck": {
"identityRisk": {
"worldwideSanctionsRiskStatus": 0,
"politicallyExposedPersonStatus": 0,
"associatePoliticallyExposedPersonStatus": 0,
"specialInterestPersonStatus": 0
},
"sanctionsAndPeps": {
"activityStatus": 0,
"aliasStatus": 0,
"aliasCount": 0,
"addressMatched": true,
"countryOfResidencyStatus": 0,
"countryOfResidencyCount": 0,
"numberOfSourcesStatus": 0,
"numberOfSourcesCount": 0,
"jurisdictionStatus": 0,
"jurisdictionCount": 0,
"hasPhoto": true,
"rolesStatus": 0,
"rolesCount": 0
}
}
},
"attemptCount": 0,
"scheduledRetryCount": 0
}
],
"smsMessages": [
{
"id": 0,
"processTaskId": 0,
"processActorId": 0,
"title": "string",
"status": 0
}
],
"identityVerificationConfig": {
"idScanType": 0,
"nameCheckMethod": 0,
"isPassMandatory": true,
"failRecaptureDocument": true,
"idScanJourney": "string",
"idScanNfcOption": 0,
"captureSelfie": true,
"livenessCheckMethod": 0,
"livenessRetries": 0,
"performIdCheck": true,
"idCheckMethod": 0,
"waitForValidation": true,
"waitForValidationEnum": 0,
"idDocumentTypes": [
0
],
"idDocumentRetries": 0,
"captureNonBiometricDocuments": true,
"includeNonBiometricInformation": true,
"nonBiometricInformation": "string",
"reviewNonBiometricDocuments": true,
"nonBiometricDocumentTypes": [
{
"id": "string",
"type": 0,
"title": "string",
"mandatoryQuantity": 0
}
],
"connectNfcOption": 0,
"pages": [
{
"page": 0,
"title": "string",
"subtitle": "string",
"text": "string",
"buttonText": "string",
"secondaryButtonText": "string",
"hasImage": true,
"base64Image": "string"
}
],
"legislation": 0,
"idvProvider": 0
},
"identityVerifications": [
{
"id": 0,
"processTaskId": 0,
"processActorId": 0,
"status": 0,
"percentageComplete": 0,
"entries": [
{
"id": "string",
"taskId": 0,
"idvId": 0,
"entityId": "string",
"entityName": "string",
"dateCreated": "string",
"hasSelfie": true,
"hasUap": true,
"livenessVerified": true,
"livenessCheckMethod": 0,
"livenessRetryRequired": true,
"livenessVerificationResult": 0,
"verificationReason": "string",
"facialMatchVerificationResult": 0,
"nameCheckVerificationResult": 0,
"verificationResult": 0,
"uapAction": 0,
"idDocumentRetryRequired": true,
"idDocuments": [
{
"id": "string",
"dateCreated": "string",
"idDocumentType": 0,
"facialMatch": true,
"facialMatchVerificationResult": 0,
"firstName": "string",
"middleName": "string",
"surname": "string",
"dateOfBirth": "string",
"documentNumber": "string",
"expiryDate": "string",
"address": "string",
"city": "string",
"postcode": "string",
"countryCode": "string",
"country": "string",
"mrzLine1": "string",
"mrzLine2": "string",
"mrzLine3": "string",
"nameCheckMatched": true,
"nameCheckVerificationResult": 0,
"verifiedBy": "string",
"verificationDate": "string",
"verificationResult": 0,
"verificationReason": "string",
"nfcReadStatus": 0,
"nfcReadDate": "string",
"nfcCheckRequired": true,
"nfcReadingComplete": true,
"visualAnalysisPassed": true,
"visualAnalysisVerificationResult": 0,
"nfcCheckPassed": true,
"nfcCheckVerificationResult": 0,
"nfcHashMatched": true,
"nfcDocumentSigned": true,
"nfcCountrySigned": true,
"backScanStatus": 0,
"uploadedBy": "string",
"scanReference": 0,
"policeRecordAlert": true,
"ageValidation": true,
"compromisedAlert": true,
"repeatAttemptAlert": true,
"dobMatchResult": 0
}
],
"nonBiometricDocuments": [
{
"id": "string",
"title": "string",
"dateCreated": "string",
"verificationResult": 0,
"verificationReason": "string",
"verifiedBy": "string",
"verificationDate": "string",
"isForRtx": true,
"fileType": 0
}
],
"visualAnalysisVerificationResult": 0,
"nfcCheckPerformed": true,
"nfcCheckPassed": true,
"dateRequested": "string",
"verifiedBy": "string",
"verificationDate": "string",
"readOnly": true,
"rtxMethod": 0,
"entityShareCode": {
"id": "string",
"shareCode": "string",
"dateOfBirth": "string",
"comment": "string",
"valid": true,
"faceMatch": true,
"nameMatch": true,
"hasCertificate": true,
"processed": true,
"invalidReason": 0
},
"captureUap": true,
"documentAlreadyUsed": true
}
],
"entityIdvId": 0
}
],
"paths": [
{
"id": 0,
"nextProcessTaskId": 0,
"processTaskDecision": {
"processActorId": 0,
"processTaskId": 0,
"key": "string",
"comparison": 0,
"comparisonValues": [
"string"
]
}
}
],
"esignDocument": {
"id": 0,
"clientId": "string",
"clientName": "string",
"processTaskId": 0,
"templateId": "string",
"name": "string",
"status": 0,
"documentSignatures": [
{
"id": 0,
"processActorId": 0,
"entityId": "string",
"title": "string",
"order": 0,
"requiredToSign": true,
"name": "string",
"signedDate": "string"
}
]
},
"webhooks": [
{
"id": "string",
"method": 0,
"url": "string",
"body": "string",
"expectedStatusCode": 0
}
],
"redirectUrls": [
{
"url": "string",
"target": 0
}
],
"emails": [
{
"id": 0,
"processActorId": 0,
"emailTemplateName": "string",
"recipientFirstName": "string",
"recipientSurname": "string",
"recipientEmail": "string",
"sentDate": "string",
"deliveredDate": "string"
}
],
"openBankingVerifications": [
{
"id": 0,
"processActorId": 0,
"complete": true
}
],
"percentageComplete": 0
}
],
"processActors": [
{
"id": 0,
"title": "string",
"entityId": "string",
"userId": "string",
"userGroupId": "string",
"clientId": "string",
"userName": "string",
"clientName": "string",
"userGroupName": "string",
"entity": {
"id": "string",
"name": "string",
"firstName": "string",
"surname": "string",
"emailAddress": "string",
"phoneNumber": "string",
"registrationCode": "string",
"reference": "string",
"dateOfBirth": "string",
"senderTelephoneNumberId": 0,
"status": 0,
"accountType": 0,
"entityUserId": "string"
},
"contactType": 0,
"emailStatus": 0,
"smsStatus": 0,
"hasBiometricDocuments": true,
"hasNonBiometricDocuments": true
}
],
"webhookUrl": "string",
"description": "string",
"locked": true,
"validationScore": 0,
"validationScoreMax": 0,
"validationDate": "string",
"userGroupName": "string",
"createdByUserName": "string",
"submitType": 0,
"clientName": "string",
"pdfPacks": [
{
"id": 0,
"title": "string"
}
],
"devices": [
{
"processActorId": 0,
"operatingSystem": 0,
"browser": 0
}
]
}
GET /check/document
GET
/check/document
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Query Parameters
profileId
Type
integer
Format
"int32"Responses
OK
JSON
[
{
"id": "string",
"title": "string",
"clientId": "string",
"journeyId": "string",
"dateCreated": "string",
"dateCompleted": "string",
"percentageComplete": 0,
"isComplete": true,
"isReadOnly": true,
"status": "string",
"webhookUrl": "string",
"description": "string",
"locked": true,
"validationScore": 0,
"validationScoreMax": 0,
"validationDate": "string",
"userGroupName": "string",
"createdByUserName": "string",
"submitType": "string",
"tasksCompleted": 0,
"clientName": "string",
"profileId": 0,
"externalId": "string",
"enabled": true,
"customerId": 0
}
]
GET /check/document/{profileId}/{checkId}
GET
/check/document/{profileId}/{checkId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredinteger
Format
"int32"checkId*
Type
Requiredstring
Responses
OK
JSON
{
"process": {
"title": "string",
"id": "string",
"clientId": "string",
"journeyId": "string",
"dateCreated": "string",
"dateCompleted": "string",
"percentageComplete": 0,
"isComplete": true,
"isReadOnly": true,
"status": 0,
"processTasks": [
{
"id": 0,
"processId": "string",
"status": 0,
"type": 0,
"title": "string",
"dateStarted": "string",
"dateCompleted": "string",
"informationPages": [
{
"id": 0,
"taskId": 0,
"confirmed": true,
"processActorId": 0,
"informationPage": {
"id": 0,
"title": "string",
"isPublic": true,
"requiresConfirmation": true,
"content": "string",
"confirmationMessage": "string",
"additionalConfirmationMessages": [
{
"id": 0,
"informationPageId": 0,
"confirmationMessage": "string"
}
]
}
}
],
"forms": [
{
"id": 0,
"title": "string",
"processTaskId": 0,
"order": 0,
"totalQuestions": 0,
"totalAnswered": 0,
"totalMandatoryQuestions": 0,
"totalMandatoryAnswered": 0,
"totalPendingApproval": 0,
"totalRejected": 0,
"entityForm": {
"id": 0,
"title": "string",
"dateStarted": "string",
"dateCompleted": "string",
"answerUpdateRequired": true,
"submitted": true,
"questions": [
{
"id": 0,
"formQuestionId": 0,
"approvalPerformedBy": "string",
"approvalStatus": 0,
"approvalTimestamp": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0,
"locked": true,
"answers": [
{
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"value": "string",
"mimeType": "string",
"optionCode": "string",
"blobReference": "string",
"hasValue": true,
"metaData": {
"additionalProperties": "string"
},
"isDefaultValue": true
}
],
"validations": [
{
"entityFormQuestionId": 0,
"entityFormQuestion": "[Circular Reference]",
"dateCreated": "string",
"approved": true,
"approvalPerformedBy": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0
}
],
"question": "string",
"type": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"lookupList": {
"id": 0,
"name": "string",
"description": "string",
"isPublic": true,
"isActive": true,
"dateCreated": "string",
"lastUpdated": "string",
"options": [
{
"id": 0,
"code": "string",
"value": "string",
"order": 0,
"dateCreated": "string",
"lastUpdated": "string"
}
]
},
"validationScoreRange": "string",
"validationScoreMax": 0,
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
"id": 0,
"formQuestionId": 0,
"enabledOnFormQuestionId": 0,
"enabledOnFormQuestion": {
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"question": "string",
"type": 0,
"formVersionId": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"validationScoreRange": "string",
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"injectionMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"currencies": "string"
},
"enabledOnValue": "string"
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"validationScores": [
0
],
"hasAnswer": true,
"isAnswerable": true,
"isOptionType": true,
"isFileType": true,
"currencies": "string"
}
],
"enabledQuestions": [
{
"id": 0,
"formQuestionId": 0,
"approvalPerformedBy": "string",
"approvalStatus": 0,
"approvalTimestamp": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0,
"locked": true,
"answers": [
{
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"value": "string",
"mimeType": "string",
"optionCode": "string",
"blobReference": "string",
"hasValue": true,
"metaData": {
"additionalProperties": "string"
},
"isDefaultValue": true
}
],
"validations": [
{
"entityFormQuestionId": 0,
"entityFormQuestion": "[Circular Reference]",
"dateCreated": "string",
"approved": true,
"approvalPerformedBy": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0
}
],
"question": "string",
"type": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"lookupList": {
"id": 0,
"name": "string",
"description": "string",
"isPublic": true,
"isActive": true,
"dateCreated": "string",
"lastUpdated": "string",
"options": [
{
"id": 0,
"code": "string",
"value": "string",
"order": 0,
"dateCreated": "string",
"lastUpdated": "string"
}
]
},
"validationScoreRange": "string",
"validationScoreMax": 0,
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
"id": 0,
"formQuestionId": 0,
"enabledOnFormQuestionId": 0,
"enabledOnFormQuestion": {
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"question": "string",
"type": 0,
"formVersionId": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"validationScoreRange": "string",
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"injectionMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"currencies": "string"
},
"enabledOnValue": "string"
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"validationScores": [
0
],
"hasAnswer": true,
"isAnswerable": true,
"isOptionType": true,
"isFileType": true,
"currencies": "string"
}
],
"totalQuestions": 0,
"totalAnswered": 0,
"totalMandatoryQuestions": 0,
"totalMandatoryAnswered": 0,
"validationDate": "string",
"validationScore": 0,
"validationScoreMax": 0,
"totalPendingApproval": 0,
"totalRejected": 0,
"isComplete": true,
"isMandatoryComplete": true,
"percentageComplete": 0
},
"processActorId": 0,
"editableByClient": true,
"submitted": true,
"dateCompleted": "string",
"percentageComplete": 0,
"validationScore": 0,
"validationScoreMax": 0
}
],
"tables": [
{
"id": 0,
"title": "string",
"processTaskId": 0,
"processActorId": 0,
"content": {
"canAddRows": true,
"columns": [
{
"order": 0,
"title": "string",
"type": 0,
"isReadonly": true,
"options": [
"string"
]
}
],
"defaultRows": [
{
"title": "string",
"values": [
"string"
]
}
],
"rows": [
{
"title": "string",
"values": [
"string"
]
}
]
},
"editableByClient": true,
"editableByEntity": true,
"order": 0,
"submitted": true,
"totalQuestions": 0,
"totalQuestionsAnswered": 0
}
],
"dataConnectors": [
{
"id": 0,
"processTaskId": 0,
"processActorId": 0,
"dataCheckStatus": 0,
"dataCheckId": 0,
"dataCheck": {
"id": 0,
"entityId": "string",
"dateCreated": "string",
"dataConnectorType": 0,
"title": "string",
"status": 0,
"gbgID3Input": {
"dataCheckId": 0,
"forename": "string",
"middleName": "string",
"surname": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"addressLine2": "string",
"postcode": "string",
"city": "string",
"county": "string",
"country": "string",
"bankAccountSortcode": "string",
"bankAccountNumber": "string"
},
"gbgID3Result": {
"dataCheckId": 0,
"searchId": "string",
"profileName": "string",
"resultText": "string",
"score": 0,
"dataSources": [
{
"resultId": 0,
"name": "string",
"description": "string",
"type": 0,
"country": "string",
"passStatus": 0,
"addressStatus": 0,
"forenameStatus": 0,
"surnameStatus": 0,
"dateOfBirthStatus": 0,
"alertStatus": 0,
"remarks": [
{
"dataSourceId": 0,
"type": 0,
"code": 0,
"description": "string"
}
]
}
],
"peps": [
{
"id": 0,
"resultId": 0,
"status": 0,
"isMismatch": true,
"fullName": "string",
"aliases": [
"string"
],
"addresses": [
"string"
],
"sanctionDates": [
"string"
],
"identityInformation": [
"string"
],
"itemId": "string",
"url": "string",
"score": 0,
"caseId": "string",
"searchId": "string",
"fcraEnabled": true,
"rank": 0,
"actionLog": [
{
"dateCreated": "string",
"previousStatus": 0,
"newStatus": 0,
"userId": "string",
"userName": "string",
"comment": "string"
}
],
"positions": [
"string"
],
"tier": 0
}
],
"sanctions": [
{
"id": 0,
"resultId": 0,
"status": 0,
"isMismatch": true,
"fullName": "string",
"aliases": [
"string"
],
"addresses": [
"string"
],
"sanctionDates": [
"string"
],
"identityInformation": [
"string"
],
"itemId": "string",
"url": "string",
"score": 0,
"caseId": "string",
"searchId": "string",
"fcraEnabled": true,
"rank": 0,
"actionLog": [
{
"dateCreated": "string",
"previousStatus": 0,
"newStatus": 0,
"userId": "string",
"userName": "string",
"comment": "string"
}
],
"sanctionBodies": [
"string"
]
}
]
},
"proofOfOwnershipInput": {
"firstName": "string",
"middleName": "string",
"surname": "string",
"addressLine1": "string",
"addressLine2": "string",
"postcode": "string",
"city": "string"
},
"proofOfOwnershipResult": {
"reference": "string",
"overallResult": 0,
"matches": [
{
"titleNumber": "string",
"firstNameMatch": 0,
"middleNameMatch": 0,
"surnameMatch": 0,
"overallMatch": 0,
"isHistorical": true,
"ownershipType": 0,
"proprietorFrom": "string",
"proprietorTo": "string",
"property": {
"buildingName": "string",
"buildingNumber": "string",
"streetName": "string",
"city": "string",
"postcode": "string",
"subBuildingName": "string",
"tenure": "string"
}
}
],
"files": [
{
"fileId": "string",
"filename": "string",
"titleNumber": "string"
}
],
"titles": [
{
"address": "string",
"tenure": "string",
"titleNumber": "string",
"matchType": 0,
"id": 0,
"status": 0
}
]
},
"acurisInput": {
"threshold": 0,
"firstName": "string",
"middleNames": "string",
"lastName": "string",
"dateOfBirth": "string",
"dateOfBirthMatching": 0,
"datasets": [
0
],
"countries": [
"string"
],
"nameMatching": 0,
"useAllCountries": true,
"useAllPepTiers": true,
"pepTiers": [
0
],
"includeMatchesWithoutDateOfBirth": true
},
"acurisResult": [
{
"id": 0,
"createdDate": "string",
"version": 0,
"resourceId": "string",
"score": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isDeceased": true,
"dateOfBirth": "string",
"dateOfDeath": "string",
"gender": 0,
"pepTier": 0,
"profileImageBlobReference": "string",
"status": 0,
"reviewByUser": "string",
"reviewDate": "string",
"reviewComments": "string",
"addresses": [
{
"addressType": 0,
"line1": "string",
"line2": "string",
"postcode": "string",
"city": "string",
"county": "string",
"countyAbbrev": "string",
"countryIsoCode": "string"
}
],
"aliases": [
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"type": 0
}
],
"contactDetails": [
{
"category": 0,
"value": "string"
}
],
"countries": [
"string"
],
"datasets": [
0
],
"disqualifiedDirectors": [
{
"caseReference": "string",
"reason": "string",
"conduct": "string",
"dateFrom": "string",
"dateTo": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
],
"identifiers": [
{
"category": "string",
"value": "string"
}
],
"imageBlobReferences": [
"string"
],
"nationalities": [
"string"
],
"peps": [
{
"countryIsoCode": "string",
"segment": "string",
"position": "string",
"dateFrom": "string",
"dateTo": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
],
"isCurrent": true
}
],
"notes": [
"string"
],
"regulatoryEnforcements": [
{
"category": 0,
"subcategory": "string",
"events": [
{
"type": "string",
"currencyCode": "string",
"amount": 0,
"periodDays": 0,
"periodMonths": 0,
"periodYears": 0,
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
]
}
],
"reputationalRiskExposures": [
{
"category": "string",
"subcategory": "string",
"events": [
{
"type": "string",
"date": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
]
}
],
"sanctions": [
{
"sanctionId": "string",
"regimeBody": "string",
"regimeName": "string",
"regimeOrigin": "string",
"events": [
{
"type": 0,
"date": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
],
"measures": [
"string"
],
"isCurrent": true
}
],
"associatedProfiles": [
{
}
],
"profilesOfInterest": [
{
"category": "string",
"positions": [
{
"title": "string",
"segment": "string",
"countryIsoCode": "string",
"dateFrom": "string",
"dateTo": "string"
}
],
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
]
}
],
"isOnGoingMonitor": true,
"isOnGoingMonitorActive": true,
"onGoingMonitorEndDate": "string",
"dataCheckNotes": [
{
"status": 0,
"noteText": "string",
"createdByUser": "string",
"dateCreated": "string"
}
],
"activeCheckStatus": 0,
"extendedInternationalCheck": {
"identityRisk": {
"worldwideSanctionsRiskStatus": 0,
"politicallyExposedPersonStatus": 0,
"associatePoliticallyExposedPersonStatus": 0,
"specialInterestPersonStatus": 0
},
"sanctionsAndPeps": {
"activityStatus": 0,
"aliasStatus": 0,
"aliasCount": 0,
"addressMatched": true,
"countryOfResidencyStatus": 0,
"countryOfResidencyCount": 0,
"numberOfSourcesStatus": 0,
"numberOfSourcesCount": 0,
"jurisdictionStatus": 0,
"jurisdictionCount": 0,
"hasPhoto": true,
"rolesStatus": 0,
"rolesCount": 0
}
}
},
"attemptCount": 0,
"scheduledRetryCount": 0
}
],
"smsMessages": [
{
"id": 0,
"processTaskId": 0,
"processActorId": 0,
"title": "string",
"status": 0
}
],
"identityVerificationConfig": {
"idScanType": 0,
"nameCheckMethod": 0,
"isPassMandatory": true,
"failRecaptureDocument": true,
"idScanJourney": "string",
"idScanNfcOption": 0,
"captureSelfie": true,
"livenessCheckMethod": 0,
"livenessRetries": 0,
"performIdCheck": true,
"idCheckMethod": 0,
"waitForValidation": true,
"waitForValidationEnum": 0,
"idDocumentTypes": [
0
],
"idDocumentRetries": 0,
"captureNonBiometricDocuments": true,
"includeNonBiometricInformation": true,
"nonBiometricInformation": "string",
"reviewNonBiometricDocuments": true,
"nonBiometricDocumentTypes": [
{
"id": "string",
"type": 0,
"title": "string",
"mandatoryQuantity": 0
}
],
"connectNfcOption": 0,
"pages": [
{
"page": 0,
"title": "string",
"subtitle": "string",
"text": "string",
"buttonText": "string",
"secondaryButtonText": "string",
"hasImage": true,
"base64Image": "string"
}
],
"legislation": 0,
"idvProvider": 0
},
"identityVerifications": [
{
"id": 0,
"processTaskId": 0,
"processActorId": 0,
"status": 0,
"percentageComplete": 0,
"entries": [
{
"id": "string",
"taskId": 0,
"idvId": 0,
"entityId": "string",
"entityName": "string",
"dateCreated": "string",
"hasSelfie": true,
"hasUap": true,
"livenessVerified": true,
"livenessCheckMethod": 0,
"livenessRetryRequired": true,
"livenessVerificationResult": 0,
"verificationReason": "string",
"facialMatchVerificationResult": 0,
"nameCheckVerificationResult": 0,
"verificationResult": 0,
"uapAction": 0,
"idDocumentRetryRequired": true,
"idDocuments": [
{
"id": "string",
"dateCreated": "string",
"idDocumentType": 0,
"facialMatch": true,
"facialMatchVerificationResult": 0,
"firstName": "string",
"middleName": "string",
"surname": "string",
"dateOfBirth": "string",
"documentNumber": "string",
"expiryDate": "string",
"address": "string",
"city": "string",
"postcode": "string",
"countryCode": "string",
"country": "string",
"mrzLine1": "string",
"mrzLine2": "string",
"mrzLine3": "string",
"nameCheckMatched": true,
"nameCheckVerificationResult": 0,
"verifiedBy": "string",
"verificationDate": "string",
"verificationResult": 0,
"verificationReason": "string",
"nfcReadStatus": 0,
"nfcReadDate": "string",
"nfcCheckRequired": true,
"nfcReadingComplete": true,
"visualAnalysisPassed": true,
"visualAnalysisVerificationResult": 0,
"nfcCheckPassed": true,
"nfcCheckVerificationResult": 0,
"nfcHashMatched": true,
"nfcDocumentSigned": true,
"nfcCountrySigned": true,
"backScanStatus": 0,
"uploadedBy": "string",
"scanReference": 0,
"policeRecordAlert": true,
"ageValidation": true,
"compromisedAlert": true,
"repeatAttemptAlert": true,
"dobMatchResult": 0
}
],
"nonBiometricDocuments": [
{
"id": "string",
"title": "string",
"dateCreated": "string",
"verificationResult": 0,
"verificationReason": "string",
"verifiedBy": "string",
"verificationDate": "string",
"isForRtx": true,
"fileType": 0
}
],
"visualAnalysisVerificationResult": 0,
"nfcCheckPerformed": true,
"nfcCheckPassed": true,
"dateRequested": "string",
"verifiedBy": "string",
"verificationDate": "string",
"readOnly": true,
"rtxMethod": 0,
"entityShareCode": {
"id": "string",
"shareCode": "string",
"dateOfBirth": "string",
"comment": "string",
"valid": true,
"faceMatch": true,
"nameMatch": true,
"hasCertificate": true,
"processed": true,
"invalidReason": 0
},
"captureUap": true,
"documentAlreadyUsed": true
}
],
"entityIdvId": 0
}
],
"paths": [
{
"id": 0,
"nextProcessTaskId": 0,
"processTaskDecision": {
"processActorId": 0,
"processTaskId": 0,
"key": "string",
"comparison": 0,
"comparisonValues": [
"string"
]
}
}
],
"esignDocument": {
"id": 0,
"clientId": "string",
"clientName": "string",
"processTaskId": 0,
"templateId": "string",
"name": "string",
"status": 0,
"documentSignatures": [
{
"id": 0,
"processActorId": 0,
"entityId": "string",
"title": "string",
"order": 0,
"requiredToSign": true,
"name": "string",
"signedDate": "string"
}
]
},
"webhooks": [
{
"id": "string",
"method": 0,
"url": "string",
"body": "string",
"expectedStatusCode": 0
}
],
"redirectUrls": [
{
"url": "string",
"target": 0
}
],
"emails": [
{
"id": 0,
"processActorId": 0,
"emailTemplateName": "string",
"recipientFirstName": "string",
"recipientSurname": "string",
"recipientEmail": "string",
"sentDate": "string",
"deliveredDate": "string"
}
],
"openBankingVerifications": [
{
"id": 0,
"processActorId": 0,
"complete": true
}
],
"percentageComplete": 0
}
],
"processActors": [
{
"id": 0,
"title": "string",
"entityId": "string",
"userId": "string",
"userGroupId": "string",
"clientId": "string",
"userName": "string",
"clientName": "string",
"userGroupName": "string",
"entity": {
"id": "string",
"name": "string",
"firstName": "string",
"surname": "string",
"emailAddress": "string",
"phoneNumber": "string",
"registrationCode": "string",
"reference": "string",
"dateOfBirth": "string",
"senderTelephoneNumberId": 0,
"status": 0,
"accountType": 0,
"entityUserId": "string"
},
"contactType": 0,
"emailStatus": 0,
"smsStatus": 0,
"hasBiometricDocuments": true,
"hasNonBiometricDocuments": true
}
],
"webhookUrl": "string",
"description": "string",
"locked": true,
"validationScore": 0,
"validationScoreMax": 0,
"validationDate": "string",
"userGroupName": "string",
"createdByUserName": "string",
"submitType": 0,
"clientName": "string",
"pdfPacks": [
{
"id": 0,
"title": "string"
}
],
"devices": [
{
"processActorId": 0,
"operatingSystem": 0,
"browser": 0
}
]
},
"status": "string",
"riskRating": "string"
}
GET /check/document/{processId}/pdf
GET
/check/document/{processId}/pdf
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
processId*
Type
Requiredstring
Responses
OK
GET /check/document/{entityId}/{entryId}/selfie
GET
/check/document/{entityId}/{entryId}/selfie
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
entityId*
Type
Requiredstring
entryId*
Type
Requiredstring
Responses
OK
GET /check/document/{entityId}/{entryId}/uap
GET
/check/document/{entityId}/{entryId}/uap
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
entityId*
Type
Requiredstring
entryId*
Type
Requiredstring
Responses
OK
GET /check/document/{entityId}/{entryId}/{idDocumentId}/id-documents/{side}
GET
/check/document/{entityId}/{entryId}/{idDocumentId}/id-documents/{side}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
entityId*
Type
Requiredstring
entryId*
Type
Requiredstring
idDocumentId*
Type
Requiredstring
side*
Type
Requiredstring
Responses
OK
POST /check/document/{checkId}/resend
POST
/check/document/{checkId}/resend
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
checkId*
Type
Requiredstring
Format
"uuid"Request Body
JSON
{
"title": "string",
"id": "string",
"clientId": "string",
"journeyId": "string",
"dateCreated": "string",
"dateCompleted": "string",
"percentageComplete": 0,
"isComplete": true,
"isReadOnly": true,
"status": 0,
"processTasks": [
{
"id": 0,
"processId": "string",
"status": 0,
"type": 0,
"title": "string",
"dateStarted": "string",
"dateCompleted": "string",
"informationPages": [
{
"id": 0,
"taskId": 0,
"confirmed": true,
"processActorId": 0,
"informationPage": {
"id": 0,
"title": "string",
"isPublic": true,
"requiresConfirmation": true,
"content": "string",
"confirmationMessage": "string",
"additionalConfirmationMessages": [
{
"id": 0,
"informationPageId": 0,
"confirmationMessage": "string"
}
]
}
}
],
"forms": [
{
"id": 0,
"title": "string",
"processTaskId": 0,
"order": 0,
"totalQuestions": 0,
"totalAnswered": 0,
"totalMandatoryQuestions": 0,
"totalMandatoryAnswered": 0,
"totalPendingApproval": 0,
"totalRejected": 0,
"entityForm": {
"id": 0,
"title": "string",
"dateStarted": "string",
"dateCompleted": "string",
"answerUpdateRequired": true,
"submitted": true,
"questions": [
{
"id": 0,
"formQuestionId": 0,
"approvalPerformedBy": "string",
"approvalStatus": 0,
"approvalTimestamp": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0,
"locked": true,
"answers": [
{
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"value": "string",
"mimeType": "string",
"optionCode": "string",
"blobReference": "string",
"hasValue": true,
"metaData": {
"additionalProperties": "string"
},
"isDefaultValue": true
}
],
"validations": [
{
"entityFormQuestionId": 0,
"entityFormQuestion": "[Circular Reference]",
"dateCreated": "string",
"approved": true,
"approvalPerformedBy": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0
}
],
"question": "string",
"type": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"lookupList": {
"id": 0,
"name": "string",
"description": "string",
"isPublic": true,
"isActive": true,
"dateCreated": "string",
"lastUpdated": "string",
"options": [
{
"id": 0,
"code": "string",
"value": "string",
"order": 0,
"dateCreated": "string",
"lastUpdated": "string"
}
]
},
"validationScoreRange": "string",
"validationScoreMax": 0,
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
"id": 0,
"formQuestionId": 0,
"enabledOnFormQuestionId": 0,
"enabledOnFormQuestion": {
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"question": "string",
"type": 0,
"formVersionId": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"validationScoreRange": "string",
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"injectionMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"currencies": "string"
},
"enabledOnValue": "string"
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"validationScores": [
0
],
"hasAnswer": true,
"isAnswerable": true,
"isOptionType": true,
"isFileType": true,
"currencies": "string"
}
],
"enabledQuestions": [
{
"id": 0,
"formQuestionId": 0,
"approvalPerformedBy": "string",
"approvalStatus": 0,
"approvalTimestamp": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0,
"locked": true,
"answers": [
{
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"value": "string",
"mimeType": "string",
"optionCode": "string",
"blobReference": "string",
"hasValue": true,
"metaData": {
"additionalProperties": "string"
},
"isDefaultValue": true
}
],
"validations": [
{
"entityFormQuestionId": 0,
"entityFormQuestion": "[Circular Reference]",
"dateCreated": "string",
"approved": true,
"approvalPerformedBy": "string",
"approvalReason": "string",
"rejectMessage": "string",
"validationScore": 0
}
],
"question": "string",
"type": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"lookupList": {
"id": 0,
"name": "string",
"description": "string",
"isPublic": true,
"isActive": true,
"dateCreated": "string",
"lastUpdated": "string",
"options": [
{
"id": 0,
"code": "string",
"value": "string",
"order": 0,
"dateCreated": "string",
"lastUpdated": "string"
}
]
},
"validationScoreRange": "string",
"validationScoreMax": 0,
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
"id": 0,
"formQuestionId": 0,
"enabledOnFormQuestionId": 0,
"enabledOnFormQuestion": {
"id": 0,
"dateCreated": "string",
"lastUpdated": "string",
"question": "string",
"type": 0,
"formVersionId": 0,
"mandatory": true,
"description": "string",
"pageNumber": 0,
"order": 0,
"readonly": true,
"confidential": true,
"hiddenOnEdit": true,
"hiddenOnView": true,
"reference": "string",
"autofillTypeId": 0,
"regexExpression": "string",
"regexValidationMessage": "string",
"approvalRequired": true,
"lookupListId": 0,
"validationScoreRange": "string",
"mandatoryApprovalComments": true,
"mandatoryRejectionComments": true,
"logicType": 0,
"dataConnectorPropertyId": 0,
"dataConnectorSourceId": 0,
"displayMode": 0,
"injectionMode": 0,
"documentConfiguration": {
"descriptionRequired": true,
"tagLabel": "string",
"tagRequired": true,
"tagsAllowed": [
{
"name": "string"
}
],
"allowedFileExtensions": [
"string"
]
},
"conditions": [
{
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"currencies": "string"
},
"enabledOnValue": "string"
}
],
"defaultValues": [
{
"id": 0,
"order": 0,
"value": "string",
"optionCode": "string"
}
],
"options": [
{
"id": 0,
"order": 0,
"value": "string",
"code": "string",
"reference": "string"
}
],
"validationScores": [
0
],
"hasAnswer": true,
"isAnswerable": true,
"isOptionType": true,
"isFileType": true,
"currencies": "string"
}
],
"totalQuestions": 0,
"totalAnswered": 0,
"totalMandatoryQuestions": 0,
"totalMandatoryAnswered": 0,
"validationDate": "string",
"validationScore": 0,
"validationScoreMax": 0,
"totalPendingApproval": 0,
"totalRejected": 0,
"isComplete": true,
"isMandatoryComplete": true,
"percentageComplete": 0
},
"processActorId": 0,
"editableByClient": true,
"submitted": true,
"dateCompleted": "string",
"percentageComplete": 0,
"validationScore": 0,
"validationScoreMax": 0
}
],
"tables": [
{
"id": 0,
"title": "string",
"processTaskId": 0,
"processActorId": 0,
"content": {
"canAddRows": true,
"columns": [
{
"order": 0,
"title": "string",
"type": 0,
"isReadonly": true,
"options": [
"string"
]
}
],
"defaultRows": [
{
"title": "string",
"values": [
"string"
]
}
],
"rows": [
{
"title": "string",
"values": [
"string"
]
}
]
},
"editableByClient": true,
"editableByEntity": true,
"order": 0,
"submitted": true,
"totalQuestions": 0,
"totalQuestionsAnswered": 0
}
],
"dataConnectors": [
{
"id": 0,
"processTaskId": 0,
"processActorId": 0,
"dataCheckStatus": 0,
"dataCheckId": 0,
"dataCheck": {
"id": 0,
"entityId": "string",
"dateCreated": "string",
"dataConnectorType": 0,
"title": "string",
"status": 0,
"gbgID3Input": {
"dataCheckId": 0,
"forename": "string",
"middleName": "string",
"surname": "string",
"dateOfBirth": "string",
"addressLine1": "string",
"addressLine2": "string",
"postcode": "string",
"city": "string",
"county": "string",
"country": "string",
"bankAccountSortcode": "string",
"bankAccountNumber": "string"
},
"gbgID3Result": {
"dataCheckId": 0,
"searchId": "string",
"profileName": "string",
"resultText": "string",
"score": 0,
"dataSources": [
{
"resultId": 0,
"name": "string",
"description": "string",
"type": 0,
"country": "string",
"passStatus": 0,
"addressStatus": 0,
"forenameStatus": 0,
"surnameStatus": 0,
"dateOfBirthStatus": 0,
"alertStatus": 0,
"remarks": [
{
"dataSourceId": 0,
"type": 0,
"code": 0,
"description": "string"
}
]
}
],
"peps": [
{
"id": 0,
"resultId": 0,
"status": 0,
"isMismatch": true,
"fullName": "string",
"aliases": [
"string"
],
"addresses": [
"string"
],
"sanctionDates": [
"string"
],
"identityInformation": [
"string"
],
"itemId": "string",
"url": "string",
"score": 0,
"caseId": "string",
"searchId": "string",
"fcraEnabled": true,
"rank": 0,
"actionLog": [
{
"dateCreated": "string",
"previousStatus": 0,
"newStatus": 0,
"userId": "string",
"userName": "string",
"comment": "string"
}
],
"positions": [
"string"
],
"tier": 0
}
],
"sanctions": [
{
"id": 0,
"resultId": 0,
"status": 0,
"isMismatch": true,
"fullName": "string",
"aliases": [
"string"
],
"addresses": [
"string"
],
"sanctionDates": [
"string"
],
"identityInformation": [
"string"
],
"itemId": "string",
"url": "string",
"score": 0,
"caseId": "string",
"searchId": "string",
"fcraEnabled": true,
"rank": 0,
"actionLog": [
{
"dateCreated": "string",
"previousStatus": 0,
"newStatus": 0,
"userId": "string",
"userName": "string",
"comment": "string"
}
],
"sanctionBodies": [
"string"
]
}
]
},
"proofOfOwnershipInput": {
"firstName": "string",
"middleName": "string",
"surname": "string",
"addressLine1": "string",
"addressLine2": "string",
"postcode": "string",
"city": "string"
},
"proofOfOwnershipResult": {
"reference": "string",
"overallResult": 0,
"matches": [
{
"titleNumber": "string",
"firstNameMatch": 0,
"middleNameMatch": 0,
"surnameMatch": 0,
"overallMatch": 0,
"isHistorical": true,
"ownershipType": 0,
"proprietorFrom": "string",
"proprietorTo": "string",
"property": {
"buildingName": "string",
"buildingNumber": "string",
"streetName": "string",
"city": "string",
"postcode": "string",
"subBuildingName": "string",
"tenure": "string"
}
}
],
"files": [
{
"fileId": "string",
"filename": "string",
"titleNumber": "string"
}
],
"titles": [
{
"address": "string",
"tenure": "string",
"titleNumber": "string",
"matchType": 0,
"id": 0,
"status": 0
}
]
},
"acurisInput": {
"threshold": 0,
"firstName": "string",
"middleNames": "string",
"lastName": "string",
"dateOfBirth": "string",
"dateOfBirthMatching": 0,
"datasets": [
0
],
"countries": [
"string"
],
"nameMatching": 0,
"useAllCountries": true,
"useAllPepTiers": true,
"pepTiers": [
0
],
"includeMatchesWithoutDateOfBirth": true
},
"acurisResult": [
{
"id": 0,
"createdDate": "string",
"version": 0,
"resourceId": "string",
"score": 0,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isDeceased": true,
"dateOfBirth": "string",
"dateOfDeath": "string",
"gender": 0,
"pepTier": 0,
"profileImageBlobReference": "string",
"status": 0,
"reviewByUser": "string",
"reviewDate": "string",
"reviewComments": "string",
"addresses": [
{
"addressType": 0,
"line1": "string",
"line2": "string",
"postcode": "string",
"city": "string",
"county": "string",
"countyAbbrev": "string",
"countryIsoCode": "string"
}
],
"aliases": [
{
"firstName": "string",
"middleName": "string",
"lastName": "string",
"type": 0
}
],
"contactDetails": [
{
"category": 0,
"value": "string"
}
],
"countries": [
"string"
],
"datasets": [
0
],
"disqualifiedDirectors": [
{
"caseReference": "string",
"reason": "string",
"conduct": "string",
"dateFrom": "string",
"dateTo": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
],
"identifiers": [
{
"category": "string",
"value": "string"
}
],
"imageBlobReferences": [
"string"
],
"nationalities": [
"string"
],
"peps": [
{
"countryIsoCode": "string",
"segment": "string",
"position": "string",
"dateFrom": "string",
"dateTo": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
],
"isCurrent": true
}
],
"notes": [
"string"
],
"regulatoryEnforcements": [
{
"category": 0,
"subcategory": "string",
"events": [
{
"type": "string",
"currencyCode": "string",
"amount": 0,
"periodDays": 0,
"periodMonths": 0,
"periodYears": 0,
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
]
}
],
"reputationalRiskExposures": [
{
"category": "string",
"subcategory": "string",
"events": [
{
"type": "string",
"date": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
]
}
],
"sanctions": [
{
"sanctionId": "string",
"regimeBody": "string",
"regimeName": "string",
"regimeOrigin": "string",
"events": [
{
"type": 0,
"date": "string",
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
],
"measures": [
"string"
],
"isCurrent": true
}
],
"associatedProfiles": [
{
}
],
"profilesOfInterest": [
{
"category": "string",
"positions": [
{
"title": "string",
"segment": "string",
"countryIsoCode": "string",
"dateFrom": "string",
"dateTo": "string"
}
],
"evidences": [
{
"sourceEvidenceId": "string",
"originalUrl": "string",
"isCopyrighted": true,
"title": "string",
"credibility": 0,
"language": "string",
"summary": "string",
"keywords": "string",
"captureDate": "string",
"publicationDate": "string",
"blobReference": "string",
"datasets": [
0
]
}
]
}
]
}
],
"isOnGoingMonitor": true,
"isOnGoingMonitorActive": true,
"onGoingMonitorEndDate": "string",
"dataCheckNotes": [
{
"status": 0,
"noteText": "string",
"createdByUser": "string",
"dateCreated": "string"
}
],
"activeCheckStatus": 0,
"extendedInternationalCheck": {
"identityRisk": {
"worldwideSanctionsRiskStatus": 0,
"politicallyExposedPersonStatus": 0,
"associatePoliticallyExposedPersonStatus": 0,
"specialInterestPersonStatus": 0
},
"sanctionsAndPeps": {
"activityStatus": 0,
"aliasStatus": 0,
"aliasCount": 0,
"addressMatched": true,
"countryOfResidencyStatus": 0,
"countryOfResidencyCount": 0,
"numberOfSourcesStatus": 0,
"numberOfSourcesCount": 0,
"jurisdictionStatus": 0,
"jurisdictionCount": 0,
"hasPhoto": true,
"rolesStatus": 0,
"rolesCount": 0
}
}
},
"attemptCount": 0,
"scheduledRetryCount": 0
}
],
"smsMessages": [
{
"id": 0,
"processTaskId": 0,
"processActorId": 0,
"title": "string",
"status": 0
}
],
"identityVerificationConfig": {
"idScanType": 0,
"nameCheckMethod": 0,
"isPassMandatory": true,
"failRecaptureDocument": true,
"idScanJourney": "string",
"idScanNfcOption": 0,
"captureSelfie": true,
"livenessCheckMethod": 0,
"livenessRetries": 0,
"performIdCheck": true,
"idCheckMethod": 0,
"waitForValidation": true,
"waitForValidationEnum": 0,
"idDocumentTypes": [
0
],
"idDocumentRetries": 0,
"captureNonBiometricDocuments": true,
"includeNonBiometricInformation": true,
"nonBiometricInformation": "string",
"reviewNonBiometricDocuments": true,
"nonBiometricDocumentTypes": [
{
"id": "string",
"type": 0,
"title": "string",
"mandatoryQuantity": 0
}
],
"connectNfcOption": 0,
"pages": [
{
"page": 0,
"title": "string",
"subtitle": "string",
"text": "string",
"buttonText": "string",
"secondaryButtonText": "string",
"hasImage": true,
"base64Image": "string"
}
],
"legislation": 0,
"idvProvider": 0
},
"identityVerifications": [
{
"id": 0,
"processTaskId": 0,
"processActorId": 0,
"status": 0,
"percentageComplete": 0,
"entries": [
{
"id": "string",
"taskId": 0,
"idvId": 0,
"entityId": "string",
"entityName": "string",
"dateCreated": "string",
"hasSelfie": true,
"hasUap": true,
"livenessVerified": true,
"livenessCheckMethod": 0,
"livenessRetryRequired": true,
"livenessVerificationResult": 0,
"verificationReason": "string",
"facialMatchVerificationResult": 0,
"nameCheckVerificationResult": 0,
"verificationResult": 0,
"uapAction": 0,
"idDocumentRetryRequired": true,
"idDocuments": [
{
"id": "string",
"dateCreated": "string",
"idDocumentType": 0,
"facialMatch": true,
"facialMatchVerificationResult": 0,
"firstName": "string",
"middleName": "string",
"surname": "string",
"dateOfBirth": "string",
"documentNumber": "string",
"expiryDate": "string",
"address": "string",
"city": "string",
"postcode": "string",
"countryCode": "string",
"country": "string",
"mrzLine1": "string",
"mrzLine2": "string",
"mrzLine3": "string",
"nameCheckMatched": true,
"nameCheckVerificationResult": 0,
"verifiedBy": "string",
"verificationDate": "string",
"verificationResult": 0,
"verificationReason": "string",
"nfcReadStatus": 0,
"nfcReadDate": "string",
"nfcCheckRequired": true,
"nfcReadingComplete": true,
"visualAnalysisPassed": true,
"visualAnalysisVerificationResult": 0,
"nfcCheckPassed": true,
"nfcCheckVerificationResult": 0,
"nfcHashMatched": true,
"nfcDocumentSigned": true,
"nfcCountrySigned": true,
"backScanStatus": 0,
"uploadedBy": "string",
"scanReference": 0,
"policeRecordAlert": true,
"ageValidation": true,
"compromisedAlert": true,
"repeatAttemptAlert": true,
"dobMatchResult": 0
}
],
"nonBiometricDocuments": [
{
"id": "string",
"title": "string",
"dateCreated": "string",
"verificationResult": 0,
"verificationReason": "string",
"verifiedBy": "string",
"verificationDate": "string",
"isForRtx": true,
"fileType": 0
}
],
"visualAnalysisVerificationResult": 0,
"nfcCheckPerformed": true,
"nfcCheckPassed": true,
"dateRequested": "string",
"verifiedBy": "string",
"verificationDate": "string",
"readOnly": true,
"rtxMethod": 0,
"entityShareCode": {
"id": "string",
"shareCode": "string",
"dateOfBirth": "string",
"comment": "string",
"valid": true,
"faceMatch": true,
"nameMatch": true,
"hasCertificate": true,
"processed": true,
"invalidReason": 0
},
"captureUap": true,
"documentAlreadyUsed": true
}
],
"entityIdvId": 0
}
],
"paths": [
{
"id": 0,
"nextProcessTaskId": 0,
"processTaskDecision": {
"processActorId": 0,
"processTaskId": 0,
"key": "string",
"comparison": 0,
"comparisonValues": [
"string"
]
}
}
],
"esignDocument": {
"id": 0,
"clientId": "string",
"clientName": "string",
"processTaskId": 0,
"templateId": "string",
"name": "string",
"status": 0,
"documentSignatures": [
{
"id": 0,
"processActorId": 0,
"entityId": "string",
"title": "string",
"order": 0,
"requiredToSign": true,
"name": "string",
"signedDate": "string"
}
]
},
"webhooks": [
{
"id": "string",
"method": 0,
"url": "string",
"body": "string",
"expectedStatusCode": 0
}
],
"redirectUrls": [
{
"url": "string",
"target": 0
}
],
"emails": [
{
"id": 0,
"processActorId": 0,
"emailTemplateName": "string",
"recipientFirstName": "string",
"recipientSurname": "string",
"recipientEmail": "string",
"sentDate": "string",
"deliveredDate": "string"
}
],
"openBankingVerifications": [
{
"id": 0,
"processActorId": 0,
"complete": true
}
],
"percentageComplete": 0
}
],
"processActors": [
{
"id": 0,
"title": "string",
"entityId": "string",
"userId": "string",
"userGroupId": "string",
"clientId": "string",
"userName": "string",
"clientName": "string",
"userGroupName": "string",
"entity": {
"id": "string",
"name": "string",
"firstName": "string",
"surname": "string",
"emailAddress": "string",
"phoneNumber": "string",
"registrationCode": "string",
"reference": "string",
"dateOfBirth": "string",
"senderTelephoneNumberId": 0,
"status": 0,
"accountType": 0,
"entityUserId": "string"
},
"contactType": 0,
"emailStatus": 0,
"smsStatus": 0,
"hasBiometricDocuments": true,
"hasNonBiometricDocuments": true
}
],
"webhookUrl": "string",
"description": "string",
"locked": true,
"validationScore": 0,
"validationScoreMax": 0,
"validationDate": "string",
"userGroupName": "string",
"createdByUserName": "string",
"submitType": 0,
"clientName": "string",
"pdfPacks": [
{
"id": 0,
"title": "string"
}
],
"devices": [
{
"processActorId": 0,
"operatingSystem": 0,
"browser": 0
}
]
}
Responses
OK
GET /profiles/{type}
GET
/profiles/{type}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
type*
Type
Requiredstring
Default
"Company"Query Parameters
count
Type
integer
Format
"int32"Default
10search
Type
string
profileId
Type
string
startDate
Type
string
endDate
Type
string
Responses
OK
GET /profile
GET
/profile
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Query Parameters
id
Type
string
Responses
OK
PUT /profile
PUT
/profile
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"autoId": 0,
"internalId": 0,
"profileType": "string",
"companyId": "string",
"safeNumber": "string",
"organizationNumber": "string",
"name": "string",
"countryCode": "string",
"createdDate": "string",
"modifiedDate": "string",
"credasEntityId": "string",
"riskRating": "string",
"status": "string",
"countOfDocumentChecks": 0,
"countOfScreeningChecks": 0,
"truePositiveHitsCount": 0,
"countOfMBChecks": 0,
"countOfIndividuals": 0,
"countOfCompletedIDV": 0,
"countOfCompanyReports": 0,
"decision": "string",
"creditLimit": 0,
"isOnStop": true,
"parentName": "string",
"parentExternalId": "string",
"customerId": 0,
"assignedTo": 0,
"id": "string",
"type": "string",
"email": "string",
"mobile": "string",
"telephone": "string",
"parentId": 0,
"address": {
"country": "string",
"propertyNumber": "string",
"buildingName": "string",
"line": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"fromDate": "string",
"toDate": "string",
"type": "string"
},
"companyDetails": {
"name": "string",
"incorporationCountry": "string",
"registrationNumber": "string",
"website": "string",
"incorporationType": "string",
"safeNo": "string"
},
"individualDetails": {
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string"
},
"personDetails": {
"id": 0,
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string",
"mainPosition": "string",
"directorId": "string",
"mobile": "string",
"telephone": "string",
"email": "string",
"dateOfAppointment": "string",
"personType": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": 0,
"profile": "[Circular Reference]"
},
"preferences": {
"selectedPreference": 0,
"includeHistoricalData": true,
"autoLinkRelationships": true,
"duplicateCheck": true,
"notifyOnCreation": true,
"requestKybReport": true
}
}
Responses
OK
POST /profile
POST
/profile
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"autoId": 0,
"internalId": 0,
"profileType": "string",
"companyId": "string",
"safeNumber": "string",
"organizationNumber": "string",
"name": "string",
"countryCode": "string",
"createdDate": "string",
"modifiedDate": "string",
"credasEntityId": "string",
"riskRating": "string",
"status": "string",
"countOfDocumentChecks": 0,
"countOfScreeningChecks": 0,
"truePositiveHitsCount": 0,
"countOfMBChecks": 0,
"countOfIndividuals": 0,
"countOfCompletedIDV": 0,
"countOfCompanyReports": 0,
"decision": "string",
"creditLimit": 0,
"isOnStop": true,
"parentName": "string",
"parentExternalId": "string",
"customerId": 0,
"assignedTo": 0,
"id": "string",
"type": "string",
"email": "string",
"mobile": "string",
"telephone": "string",
"parentId": 0,
"address": {
"country": "string",
"propertyNumber": "string",
"buildingName": "string",
"line": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"fromDate": "string",
"toDate": "string",
"type": "string"
},
"companyDetails": {
"name": "string",
"incorporationCountry": "string",
"registrationNumber": "string",
"website": "string",
"incorporationType": "string",
"safeNo": "string"
},
"individualDetails": {
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string"
},
"personDetails": {
"id": 0,
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"dob": "string",
"gender": "string",
"nationality": "string",
"birthCountry": "string",
"ssn": "string",
"socialInsuranceNumber": "string",
"nationalIdentityNumber": "string",
"taxIdentificationNumber": "string",
"mainPosition": "string",
"directorId": "string",
"mobile": "string",
"telephone": "string",
"email": "string",
"dateOfAppointment": "string",
"personType": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": 0,
"profile": "[Circular Reference]"
},
"preferences": {
"selectedPreference": 0,
"includeHistoricalData": true,
"autoLinkRelationships": true,
"duplicateCheck": true,
"notifyOnCreation": true,
"requestKybReport": true
}
}
Responses
OK
PUT /profile/address
PUT
/profile/address
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"autoId": 0,
"id": "string",
"type": "string",
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": "string",
"addressId": 0,
"address": {
"autoId": 0,
"externalId": "string",
"type": "string",
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"fromDate": "string",
"toDate": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": "string",
"enabled": true,
"creditsafe_Addresses": [
{
"autoId": 0,
"id": "string",
"type": "string",
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": "string",
"addressId": 0,
"address": "[Circular Reference]"
}
]
},
"externalId": "string",
"fromDate": "string",
"toDate": "string"
}
Responses
OK
POST /profile/address
POST
/profile/address
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"autoId": 0,
"id": "string",
"type": "string",
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": "string",
"addressId": 0,
"address": {
"autoId": 0,
"externalId": "string",
"type": "string",
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"fromDate": "string",
"toDate": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": "string",
"enabled": true,
"creditsafe_Addresses": [
{
"autoId": 0,
"id": "string",
"type": "string",
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": "string",
"addressId": 0,
"address": "[Circular Reference]"
}
]
},
"externalId": "string",
"fromDate": "string",
"toDate": "string"
}
Responses
OK
DELETE /profile/address
DELETE
/profile/address
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"autoId": 0,
"id": "string",
"type": "string",
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": "string",
"addressId": 0,
"address": {
"autoId": 0,
"externalId": "string",
"type": "string",
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"fromDate": "string",
"toDate": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": "string",
"enabled": true,
"creditsafe_Addresses": [
{
"autoId": 0,
"id": "string",
"type": "string",
"buildingDetails": "string",
"street": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"countryCode": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string",
"profileId": "string",
"addressId": 0,
"address": "[Circular Reference]"
}
]
},
"externalId": "string",
"fromDate": "string",
"toDate": "string"
}
Responses
OK
POST /Lookups/searchCompanies
POST
/Lookups/searchCompanies
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"page": 0,
"pageSize": 0,
"countries": 0,
"language": "string",
"id": "string",
"safeNo": "string",
"regNo": "string",
"vatNo": "string",
"name": "string",
"tradeName": "string",
"acronym": "string",
"exact": true,
"address": "string",
"street": "string",
"houseNo": "string",
"city": "string",
"postCode": "string",
"province": "string",
"callRef": "string",
"officeType": 0,
"phoneNo": [
"string"
],
"status": 0,
"type": 0,
"website": "string",
"customData": "string"
}
Responses
OK
JSON
{
"id": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
POST /Lookups/companyCreditReport
POST
/Lookups/companyCreditReport
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"accept": "string",
"language": "string",
"template": "string",
"includeIndicators": true,
"customData": "string",
"callRef": "string",
"connectId": "string",
"profileId": 0,
"customerId": 0,
"userId": "string",
"includeCreditReport": true
}
Responses
Bad Request
JSON
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"additionalProperties": "string"
}
POST /lookups/searchDirectors
POST
/lookups/searchDirectors
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"countries": "string",
"page": 0,
"pageSize": 0,
"peopleId": "string",
"firstName": "string",
"lastName": "string",
"localDirectorNumber": "string",
"dateOfBirth": "string",
"callRef": "string"
}
Responses
OK
JSON
{
"messages": [
{
"type": 0,
"code": 0,
"text": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"additionalProperties": {
"additionalProperties": "string"
},
"correlationId": "string",
"directors": [
{
"peopleId": "string",
"firstName": "string",
"lastName": "string",
"country": 0,
"company": {
"id": "string",
"additionalProperties": {
"additionalProperties": "string"
}
},
"companyName": "string",
"companyType": 0,
"companyRegistrationNumber": "string",
"status": "string",
"address": {
"type": "string",
"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"additionToAddress": "string",
"city": "string",
"postalCode": "string",
"province": "string",
"region": "string",
"telephone": "string",
"directMarketingOptOut": true,
"directMarketingOptIn": true,
"country": 0,
"additionalProperties": {
"additionalProperties": "string"
}
},
"dateOfLatestChange": "string",
"dateOfBirth": "string",
"localDirectorNumber": "string",
"score": 0,
"taxCode": "string",
"searchRanking": "string",
"additionalProperties": {
"additionalProperties": "string"
}
}
],
"totalSize": 0
}
POST /Lookups/companiesHouse/owners
POST
/Lookups/companiesHouse/owners
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"companyNumber": "string"
}
Responses
OK
JSON
[
]
POST /Lookups/companiesHouse/profile
POST
/Lookups/companiesHouse/profile
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"companyNumber": "string"
}
Responses
OK
JSON
[
]
POST /Lookups/companiesHouse/officers
POST
/Lookups/companiesHouse/officers
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"companyNumber": "string"
}
Responses
OK
JSON
[
]
POST /Lookups/companiesHouse/search/officers
POST
/Lookups/companiesHouse/search/officers
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"q": "string",
"itemsPerPage": 0,
"startIndex": 0
}
Responses
OK
JSON
{
"etag": "string",
"items": [
{
"address": {
"addressLine1": "string",
"addressLine2": "string",
"careOf": "string",
"country": "string",
"locality": "string",
"poBox": "string",
"postalCode": "string",
"premises": "string",
"region": "string"
},
"addressSnippet": "string",
"appointmentCount": 0,
"dateOfBirth": {
"month": 0,
"year": 0
},
"description": "string",
"descriptionIdentifiers": [
"string"
],
"kind": "string",
"links": {
"self": "string"
},
"matches": {
"addressSnippet": [
0
],
"snippet": [
0
],
"title": [
0
]
},
"snippet": "string",
"title": "string"
}
],
"itemsPerPage": 0,
"kind": "string",
"startIndex": 0,
"totalResults": 0
}
POST /monitoring/acknowledge
POST
/monitoring/acknowledge
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"monitoringEventId": 0,
"alertType": "string"
}
Responses
OK
GET /profiles/{profileId}/notes
GET
/profiles/{profileId}/notes
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredinteger
Format
"int32"Responses
OK
POST /profiles/{profileId}/note
POST
/profiles/{profileId}/note
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredinteger
Format
"int32"Request Body
JSON
{
"profileId": 0,
"content": "string"
}
Responses
OK
PUT /profiles/{profileId}/note/{noteId}
PUT
/profiles/{profileId}/note/{noteId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredinteger
Format
"int32"noteId*
Type
Requiredinteger
Format
"int32"Request Body
JSON
{
"profileId": 0,
"content": "string"
}
Responses
OK
DELETE /profiles/{profileId}/note/{noteId}
DELETE
/profiles/{profileId}/note/{noteId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredinteger
Format
"int32"noteId*
Type
Requiredinteger
Format
"int32"Responses
OK
Risk
Operations
GET/Risk/policiesGET/Risk/policies/{id}POST/Risk/policyPOST/Risk/policy/analyzeGET/Risk/policy/analyze/historyGET/Risk/decision/history/{profileId}GET/Risk/decision/{profileId}PUT/Risk/decision/{profileId}POST/Risk/decision/{profileId}DELETE/Risk/decision/{profileId}POST/Risk/decision/{profileId}/stopDELETE/Risk/decision/{profileId}/stopGET/Risk/decision/stop/history/{profileId}
GET /Risk/policies
GET
/Risk/policies
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Query Parameters
id
Type
string
Responses
OK
JSON
[
{
"policyName": "string",
"policyId": "string",
"policyVersion": "string",
"currency": "string",
"createdDate": "string",
"updatedDate": "string",
"isActive": true,
"policyJson": "string",
"rules": [
{
"ruleId": "string",
"policyId": "string",
"description": "string",
"maxExposure": 0,
"createdDate": "string",
"updatedDate": "string",
"policy": "[Circular Reference]",
"applicability": {
"applicabilityId": 0,
"ruleId": "string",
"maxPd": 0,
"createdDate": "string",
"updatedDate": "string",
"rule": "[Circular Reference]",
"countries": [
{
"applicabilityCountryId": 0,
"applicabilityId": 0,
"countryCode": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"riskRatings": [
{
"riskRatingId": 0,
"applicabilityId": 0,
"riskRating": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
]
},
"conditions": [
{
"conditionId": 0,
"ruleId": "string",
"condition": "string",
"conditionOrder": 0,
"createdDate": "string",
"rule": "[Circular Reference]"
}
]
}
]
}
]
GET /Risk/policies/{id}
GET
/Risk/policies/{id}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
id*
Type
Requiredstring
Responses
OK
JSON
{
"policyName": "string",
"policyId": "string",
"policyVersion": "string",
"currency": "string",
"createdDate": "string",
"updatedDate": "string",
"isActive": true,
"policyJson": "string",
"rules": [
{
"ruleId": "string",
"policyId": "string",
"description": "string",
"maxExposure": 0,
"createdDate": "string",
"updatedDate": "string",
"policy": "[Circular Reference]",
"applicability": {
"applicabilityId": 0,
"ruleId": "string",
"maxPd": 0,
"createdDate": "string",
"updatedDate": "string",
"rule": "[Circular Reference]",
"countries": [
{
"applicabilityCountryId": 0,
"applicabilityId": 0,
"countryCode": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
],
"riskRatings": [
{
"riskRatingId": 0,
"applicabilityId": 0,
"riskRating": "string",
"createdDate": "string",
"applicability": "[Circular Reference]"
}
]
},
"conditions": [
{
"conditionId": 0,
"ruleId": "string",
"condition": "string",
"conditionOrder": 0,
"createdDate": "string",
"rule": "[Circular Reference]"
}
]
}
]
}
POST /Risk/policy
POST
/Risk/policy
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Request Body
JSON
{
"content": "string",
"title": "string"
}
Responses
Created
POST /Risk/policy/analyze
POST
/Risk/policy/analyze
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Query Parameters
policyId
Type
string
companyConnectId
Type
string
freshAnalysis
Type
boolean
Default
falseRequest Body
JSON
{
"prompt": "string"
}
Responses
OK
JSON
{
"id": "string",
"prompt": "string",
"response": "string",
"model": "string",
"location": "string",
"projectId": "string",
"webSearchQueries": "string",
"searchQueriesCount": 0,
"groundingSupportsCount": 0,
"createdAt": "string"
}
GET /Risk/policy/analyze/history
GET
/Risk/policy/analyze/history
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Query Parameters
policyId
Type
string
companyConnectId
Type
string
Responses
OK
JSON
[
{
"autoId": 0,
"customerId": 0,
"policyId": "string",
"companyConnectId": "string",
"vertexAiResponseId": "string",
"vertexAiResponse": "string",
"createdAt": "string"
}
]
GET /Risk/decision/history/{profileId}
GET
/Risk/decision/history/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Responses
OK
JSON
[
{
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
}
]
GET /Risk/decision/{profileId}
GET
/Risk/decision/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Responses
OK
JSON
{
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
}
PUT /Risk/decision/{profileId}
PUT
/Risk/decision/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Request Body
JSON
{
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"reason": "string",
"isOnStop": true
}
Responses
OK
JSON
{
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
}
POST /Risk/decision/{profileId}
POST
/Risk/decision/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Request Body
JSON
{
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"reason": "string",
"isOnStop": true
}
Responses
Created
JSON
{
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
}
DELETE /Risk/decision/{profileId}
DELETE
/Risk/decision/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Responses
No Content
POST /Risk/decision/{profileId}/stop
POST
/Risk/decision/{profileId}/stop
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Request Body
JSON
{
"action": "string",
"reason": "string"
}
Responses
OK
JSON
{
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
}
DELETE /Risk/decision/{profileId}/stop
DELETE
/Risk/decision/{profileId}/stop
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Request Body
JSON
{
"action": "string",
"reason": "string"
}
Responses
OK
JSON
{
"profileDecisionId": 0,
"profileId": 0,
"decision": "string",
"creditLimit": 0,
"reviewDate": "string",
"assignedToUserId": 0,
"isOnStop": true,
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"assignedToUser": "[Circular Reference]",
"profile": "[Circular Reference]"
}
GET /Risk/decision/stop/history/{profileId}
GET
/Risk/decision/stop/history/{profileId}
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Parameters
Path Parameters
profileId*
Type
Requiredstring
Responses
OK
JSON
[
{
"stopHistoryId": 0,
"profileId": 0,
"action": "string",
"reason": "string",
"createdAt": "string",
"createdBy": "string",
"profile": "[Circular Reference]"
}
]
GET /api/TokenManagement/status
GET
/api/TokenManagement/status
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Responses
OK
POST /api/TokenManagement/refresh
POST
/api/TokenManagement/refresh
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Responses
OK
DELETE /api/TokenManagement/invalidate
DELETE
/api/TokenManagement/invalidate
Authorizations
Bearer
JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'
Type
API Key (header: Authorization)
Basic
Basic Authentication with username and password.
Type
HTTP (basic)
Responses
OK