Checkio API

API Schemas

Browse all data types and schemas used in the Checkio API.

159 total schemas
ResponseMeta
object
request
object
timeTakenMs
integer (int64)
wallet
object
balance
integer (int64)
cost
integer (int64)
Error
object
code
string
message
string
MyIpResponse
object
ipAddress
string
MyProfileResponse
object
id
string (uuid)
firstName
string
lastName
string
email
string (email)
totpEnabled
boolean
profilePictureUrl
string
updatedAt
string (date-time)
createdAt
string (date-time)
TenantListResponse
object
items
array
TenantListItem[]
TenantListItem
total
integer
token
string
TenantListItem
object
id
string (uuid)
name
string
isEnabled
boolean
createdAt
string (date-time)
lastAccessedAt
string (date-time)
SelectTenantRequest
object
tenantId
string
required
SelectTenantResponse
object
id
string
name
string
SignInsListResponse
object
items
array
SignInRecord[]
SignInRecord
total
integer
page
integer
pageSize
integer
SignInRecord
object
id
string
ipAddress
string
userAgent
string
latitude
number
longitude
number
city
string
country
string
success
boolean
failureReason
string
createdAt
string (date-time)
ChangePasswordRequest
object
currentPassword
string
required
newPassword
string
required
confirmPassword
string
required
- Must match newPassword
SetupTOTPResponse
object
secret
string
- Base32-encoded TOTP secret
uri
string
- otpauth:// URI for importing into authenticator apps
qrCode
string
- Base64-encoded PNG data URI of the QR code
ConfirmTOTPRequest
object
code
string
required
- 6-digit TOTP code from the authenticator app
DisableTOTPRequest
object
password
string
required
- Current account password for verification
Permission
object
code
string
name
string
description
string
category
string
TenantProfileResponse
object
id
string (uuid)
name
string
hasLogo
boolean
logoUrl
string
updatedAt
string (date-time)
createdAt
string (date-time)
TenantDetailsResponse
object
id
string (uuid)
name
string
isEnabled
boolean
balance
integer (int64)
hasLogo
boolean
updatedAt
string (date-time)
createdAt
string (date-time)
UpdateTenantRequest
object
name
string
isEnabled
boolean
UpdateTenantResponse
object
id
string
EffectivePermissionsResponse
object
permissions
array
string[]
Provider
object
id
string
name
string
SearchType
object
id
string
name
string
GenerateCreditReportRequest
object
sessionId
string
required
bureaus
array
"equifax" | "experian" | "transunion"[]
required
ipAddress
string
required
searchType
string
required
title
string
firstName
string
required
middleName
string
lastName
string
required
dateOfBirth
string (date)
required
gender
string
mobileNumber
string
email
string (email)
externalReference
string
addresses
array
Address[]
required
Address
test
boolean
challengeOptions
ChallengeOptions
status
string
enum: "allow" | "block" | "challenge"
url
string
- Optional callback URL for verification. In production, specify your website URL.
Address
object
type
string
ukAddress
UKAddress
subBuildingName
string
buildingName
string
buildingNumber
string
thoroughfare
string
townOrCity
string
district
string
county
string
country
string
postcode
string
UKAddress
object
subBuildingName
string
buildingName
string
buildingNumber
string
thoroughfare
string
townOrCity
string
district
string
county
string
country
string
postcode
string
ChallengeOptions
object
status
string
enum: "allow" | "block" | "challenge"
GenerateCreditReportResponse
object
meta
ResponseMeta
request
object
wallet
object
data
object
status
string
challengeType
string
creditReportId
string
creditReport
unknown
challenge
object
CreditReportDto
object

The parsed credit report data from the bureau

person
PersonDto
title
string
firstName
string
middleName
string
lastName
string
dateOfBirth
string
residencies
array
ResidencyDto[]
ResidencyDto
consumerData
ConsumerDataDto
records
array
ConsumerRecordDto[]
previousSearches
PreviousSearchDataDto
providers
array
PreviousSearchProviderDto[]
PersonDto
object
title
string
firstName
string
middleName
string
lastName
string
dateOfBirth
string
ResidencyDto
object
addressId
string
address
unknown
timeFrom
string (date-time)
timeTo
string (date-time)
yearsAtAddress
integer
monthsAtAddress
integer
isCurrent
boolean
ConsumerDataDto
object
records
array
ConsumerRecordDto[]
ConsumerRecordDto
ConsumerRecordDto
object
dateOfBirth
string
title
string
firstName
string
middleName
string
lastName
string
accountNumber
string
accountType
string
accountStatus
string
companyType
string
companyName
string
numberOfPayments
integer
repaymentPeriod
integer
payment
unknown
startBalance
unknown
balance
unknown
startDate
string
settledDate
string
addressId
string
address
unknown
bureaus
array
BureauReferenceDto[]
BureauReferenceDto
MoneyDto
object
amount
integer (int64)
currency
string
BureauReferenceDto
object

Reference to a credit bureau source for a record

id
string
- Bureau identifier (e.g., "equifax", "transunion")
ref
string
- Provider's reference ID for this record at this bureau
PreviousSearchDataDto
object
providers
array
PreviousSearchProviderDto[]
PreviousSearchProviderDto
PreviousSearchProviderDto
object
companyName
string
records
array
PreviousSearchRecordDto[]
PreviousSearchRecordDto
PreviousSearchRecordDto
object
date
string (date-time)
AddressResponseDto
object

Address with formatted fields for display

type
string
- Country code (e.g., "uk")
ukAddress
UKAddressResponseDto
subBuildingName
string
buildingName
string
buildingNumber
string
thoroughfare
string
townOrCity
string
district
string
county
string
country
string
postcode
string
addressLine1
string
- First line of formatted address
addressLine2
string
- Second line of formatted address
lines
array
string[]
UKAddressResponseDto
object
subBuildingName
string
buildingName
string
buildingNumber
string
thoroughfare
string
townOrCity
string
district
string
county
string
country
string
postcode
string
CreditReportListResponse
object
items
array
CreditReportListItem[]
CreditReportListItem
total
integer
nextPageToken
string
CreditReportListItem
object
id
string
title
string
firstName
string
middleName
string
lastName
string
dateOfBirth
string
emailAddress
string
mobileNumber
string
ipAddress
string
status
string
isTest
boolean
createdAt
string (date-time)
CreditReportData
object
id
string
providers
array
string[]
externalReference
string
sessionId
string
billingSessionId
string
isTest
boolean
searchType
string
title
string
firstName
string
middleName
string
lastName
string
dateOfBirth
string (date)
emailAddress
string (email)
mobileNumber
string
ipAddress
string
gender
string
addresses
array
AddressResponseDto[]
AddressResponseDto
status
string
errorMessage
string
createdAt
string (date-time)
completedAt
string (date-time)
creditReport
unknown
url
string
- Callback URL for verification
SubmitOTPChallengeRequest
object
challengeId
string
required
code
string
required
SubmitKBAChallengeRequest
object
challengeId
string
required
answers
array
object[]
required
questionId
string
answerId
string
SubmitChallengeResponse
object
meta
ResponseMeta
request
object
wallet
object
data
object
status
string
errorMessage
string
creditReportId
string
creditReport
unknown
attemptsRemaining
integer
ChallengeListItem
object
id
string
challengeType
string
provider
string
status
string
attempts
integer
maxAttempts
integer
expiresAt
string (date-time)
completedAt
string (date-time)
createdAt
string (date-time)
TimelineResponse
object
items
array
TimelineItem[]
TimelineItem
TimelineItem
object
id
string
type
string
enum: "activity" | "challenge"
createdAt
string (date-time)
code
string
status
string
message
string
durationMs
integer
challengeType
string
provider
string
challengeStatus
string
attempts
integer
maxAttempts
integer
expiresAt
string (date-time)
completedAt
string (date-time)
ResendOTPSmsRequest
object
challengeId
string
required
- The ID of the OTP challenge to resend SMS for
ResendOTPSmsResponse
object
meta
ResponseMeta
request
object
wallet
object
data
object
remainingSmsCount
integer
- Number of SMS sends remaining for this challenge
smsSentCount
integer
- Total number of SMS messages sent for this challenge
CreditReportAnalyticsResponse
object
summary
required
AnalyticsSummary
totalReports
integer (int64)
- Total number of credit reports in the date range
successRate
number (double)
- Percentage of reports with completed status (0-100)
totalPending
integer (int64)
- Number of reports with pending status
totalFailed
integer (int64)
- Number of reports with failed status
totalCompleted
integer (int64)
- Number of reports with completed status
dailyBreakdown
array
DailyBreakdown[]
required
DailyBreakdown
statusDistribution
array
StatusDistribution[]
required
StatusDistribution
dateFrom
string (date-time)
required
- Start of the analytics date range
dateTo
string (date-time)
required
- End of the analytics date range
AnalyticsSummary
object

Summary statistics for credit reports

totalReports
integer (int64)
- Total number of credit reports in the date range
successRate
number (double)
- Percentage of reports with completed status (0-100)
totalPending
integer (int64)
- Number of reports with pending status
totalFailed
integer (int64)
- Number of reports with failed status
totalCompleted
integer (int64)
- Number of reports with completed status
DailyBreakdown
object

Credit report counts for a single day

date
string (date)
- The date (YYYY-MM-DD)
completedCount
integer (int64)
- Number of completed reports
failedCount
integer (int64)
- Number of failed reports
otherCount
integer (int64)
- Number of reports in other statuses (pending, authentication-required, blocked)
StatusDistribution
object

Count of reports per status

status
string
- The status value
count
integer (int64)
- Number of reports with this status
PostcodeLookupRequest
object
postcode
string
required
PostcodeLookupResponse
object
meta
ResponseMeta
request
object
wallet
object
data
object
postcode
string
longitude
number
latitude
number
addresses
array
UKAddressResponse[]
UKAddressResponse
object
organisation_name
string
formatted
array
string[]
line_1
string
line_2
string
line_3
string
line_4
string
sub_building_name
string
building_name
string
building_number
string
thoroughfare
string
town_or_city
string
district
string
county
string
country
string
postcode
string
reference
string
latitude
number
longitude
number
LocationStatsResponse
object
totalSearches
integer (int32)
- Total number of searches in the period
successRate
number (double)
- Percentage of successful searches (0-100)
avgResponseTimeMs
integer (int32)
- Average response time in milliseconds
creditsUsed
integer (int64)
- Total credits consumed
totalSearchesTrend
number (double)
- Percentage change from previous period
successRateTrend
number (double)
- Percentage change from previous period
avgResponseTimeTrend
number (double)
- Percentage change from previous period
creditsUsedTrend
number (double)
- Percentage change from previous period
validationErrors
integer (int32)
- Number of validation errors (invalid postcode format)
notFoundErrors
integer (int32)
- Number of not found errors (valid postcode but no addresses)
serviceErrors
integer (int32)
- Number of service errors (external service failures)
RecentSearchesResponse
object
searches
array
RecentSearch[]
RecentSearch
RecentSearch
object
id
string (uuid)
postcode
string
addressCount
integer (int32)
cost
integer (int64)
responseTimeMs
integer (int32)
success
boolean
errorType
string
enum: "validation" | "not-found" | "service-error"- Error type if the search failed ("validation", "not-found", "service-error"), empty for success
createdAt
string (date-time)
ApiUsageByDayResponse
object
usage
array
DailyApiUsage[]
DailyApiUsage
DailyApiUsage
object
date
string (date)
- Date in YYYY-MM-DD format
postcodeLookup
integer (int32)
- Number of postcode lookup requests
addressSearch
integer (int32)
- Number of address search requests (reserved for future)
geocoding
integer (int32)
- Number of geocoding requests (reserved for future)
ResponseTimeByDayResponse
object
responseTimes
array
DailyResponseTime[]
DailyResponseTime
DailyResponseTime
object
date
string (date)
- Date in YYYY-MM-DD format
avg
integer (int32)
- Average response time in milliseconds
p95
integer (int32)
- 95th percentile response time in milliseconds
p99
integer (int32)
- 99th percentile response time in milliseconds
TopPostcodeDistrictsResponse
object
districts
array
PostcodeDistrictStats[]
PostcodeDistrictStats
PostcodeDistrictStats
object
postcodeDistrict
string
- Postcode district (outward code, e.g., SW1A)
count
integer (int32)
- Number of searches for this district
percentage
number (double)
- Percentage relative to the most searched district (0-100)
VerificationStatsResponse
object
totalVerifications
integer (int32)
- Total number of verifications in the period
successRate
number (double)
- Percentage of successful verifications (0-100)
avgResponseTimeMs
integer (int32)
- Average response time in milliseconds
creditsUsed
integer (int64)
- Total credits consumed
totalVerificationsTrend
number (double)
- Percentage change from previous period
successRateTrend
number (double)
- Percentage change from previous period
avgResponseTimeTrend
number (double)
- Percentage change from previous period
creditsUsedTrend
number (double)
- Percentage change from previous period
validationErrors
integer (int32)
- Number of validation errors
timeoutErrors
integer (int32)
- Number of timeout errors
serviceErrors
integer (int32)
- Number of service errors
RecentVerificationsResponse
object
verifications
array
RecentVerification[]
RecentVerification
RecentVerification
object
id
string (uuid)
checkType
string
enum: "email-check" | "mobile-check" | "selfie-check" | "signature-check" | "aml-check"- Type of verification check
identifier
string
- Identifier used for the check (e.g., email address, phone number)
cost
integer (int64)
responseTimeMs
integer (int32)
success
boolean
errorType
string
enum: "validation" | "timeout" | "service-error"- Error type if the check failed ("validation", "timeout", "service-error"), empty for success
createdAt
string (date-time)
VerificationUsageByDayResponse
object
usage
array
DailyVerificationUsage[]
DailyVerificationUsage
DailyVerificationUsage
object
date
string (date)
- Date in YYYY-MM-DD format
emailCheck
integer (int32)
- Number of email check requests
mobileCheck
integer (int32)
- Number of mobile check requests
selfieCheck
integer (int32)
- Number of selfie check requests
signatureCheck
integer (int32)
- Number of signature check requests
amlCheck
integer (int32)
- Number of AML check requests
VerificationResponseTimeByDayResponse
object
responseTimes
array
DailyVerificationResponseTime[]
DailyVerificationResponseTime
DailyVerificationResponseTime
object
date
string (date)
- Date in YYYY-MM-DD format
avg
integer (int32)
- Average response time in milliseconds
p95
integer (int32)
- 95th percentile response time in milliseconds
p99
integer (int32)
- 99th percentile response time in milliseconds
VerificationTypeBreakdownResponse
object
types
array
VerificationTypeStats[]
VerificationTypeStats
VerificationTypeStats
object
checkType
string
enum: "email-check" | "mobile-check" | "selfie-check" | "signature-check" | "aml-check"- Type of verification check
totalRequests
integer (int32)
- Total number of requests for this type
successfulRequests
integer (int32)
- Number of successful requests
successRate
number (double)
- Percentage of successful requests (0-100)
avgResponseTimeMs
integer (int32)
- Average response time in milliseconds
EmailCheckRequest
object
emailAddress
string (email)
required
EmailCheckResponse
object
meta
ResponseMeta
request
object
wallet
object
data
object
email
string
passed
boolean
hasMxRecord
boolean
isValid
boolean
MobileCheckRequest
object
mobileNumber
string
required
countryCode
string
MobileCheckResponse
object
meta
ResponseMeta
request
object
wallet
object
data
object
mobileNumber
string
normalized
string
passed
boolean
isValid
boolean
isActive
boolean
isReserved
boolean
- Whether the number is in a TV/Film reserved range
networkName
string
SelfieCheckResponse
object
meta
ResponseMeta
request
object
wallet
object
data
object
hasValidIdentification
boolean
hasFaces
boolean
similarity
number
SelfieCheckV2Response
object
meta
ResponseMeta
request
object
wallet
object
data
object
passed
boolean
confidence
number
reason
string
documentType
string
isValidDocument
boolean
documentRejectionReason
string
selfieFaceConfidence
number
photoIdFaceConfidence
number
SignatureCheckV1Response
object
meta
ResponseMeta
request
object
wallet
object
data
object
passed
boolean
confidence
number
SignatureCheckV2Response
object
meta
ResponseMeta
request
object
wallet
object
data
object
looksLikeSignature
boolean
signatureConfidence
number
nameMatchConfidence
number
verdict
string
nameHints
array
string[]
matchNotes
string
containsProfanity
boolean
profanityWords
array
string[]
containsObsceneImagery
boolean
obsceneDescription
string
AMLCheckRequest
object
firstName
string
required
lastName
string
required
middleName
string
dateOfBirth
string
required
address
required
Address
type
string
ukAddress
UKAddress
AMLCheckAddress
object
buildingNumber
string
buildingName
string
subBuildingName
string
thoroughfare
string
townOrCity
string
county
string
country
string
postcode
string
AMLCheckData
object
id
string (uuid)
status
string
enum: "pending" | "completed" | "failed"
passed
boolean
nameCheck
boolean
dobCheck
boolean
addressCheck
boolean
pepCheck
boolean
documentCheck
boolean
mortalityCheck
boolean
reportUrl
string
errorMessage
string
createdAt
string (date-time)
updatedAt
string (date-time)
firstName
string
lastName
string
middleName
string
dateOfBirth
string
- ISO date (YYYY-MM-DD)
address
AMLCheckAddress
buildingNumber
string
buildingName
string
subBuildingName
string
thoroughfare
string
townOrCity
string
county
string
country
string
postcode
string
externalReference
string
transactionId
string
AMLCheckResponse
object
meta
ResponseMeta
request
object
wallet
object
data
AMLCheckData
id
string (uuid)
status
string
enum: "pending" | "completed" | "failed"
passed
boolean
nameCheck
boolean
dobCheck
boolean
addressCheck
boolean
pepCheck
boolean
documentCheck
boolean
mortalityCheck
boolean
reportUrl
string
errorMessage
string
createdAt
string (date-time)
updatedAt
string (date-time)
firstName
string
lastName
string
middleName
string
dateOfBirth
string
- ISO date (YYYY-MM-DD)
address
AMLCheckAddress
externalReference
string
transactionId
string
AMLCheckListResponse
object
items
array
AMLCheckData[]
AMLCheckData
total
integer
RoleListResponse
object
items
array
RoleListItem[]
RoleListItem
total
integer
RoleListItem
object
id
string (uuid)
name
string
description
string
isSystem
boolean
createdAt
string (date-time)
CreateRoleRequest
object
name
string
required
description
string
UpdateRoleRequest
object
name
string
description
string
RoleResponse
object
id
string (uuid)
name
string
description
string
permissions
array
string[]
isSystem
boolean
createdAt
string (date-time)
UpdateRolePermissionsRequest
object
permissions
array
string[]
required
UserListResponse
object
items
array
UserListItem[]
UserListItem
total
integer
UserListItem
object
id
string (uuid)
firstName
string
lastName
string
email
string (email)
isEnabled
boolean
createdAt
string (date-time)
CreateTenantUserRequest
object
firstName
string
required
lastName
string
required
email
string (email)
required
password
string
isEnabled
boolean
CreateTenantUserResponse
object
id
string (uuid)
firstName
string
lastName
string
email
string
isEnabled
boolean
createdAt
string (date-time)
TenantUserResponse
object
id
string (uuid)
firstName
string
lastName
string
email
string (email)
isEnabled
boolean
createdAt
string (date-time)
AssignRoleRequest
object
roleId
string (uuid)
required
UserPermissionsResponse
object
permissions
array
string[]
CredentialListResponse
object
items
array
CredentialListItem[]
CredentialListItem
total
integer
CredentialListItem
object
id
string (uuid)
name
string
isActive
boolean
lastUsedAt
string (date-time)
createdAt
string (date-time)
CreateCredentialRequest
object
name
string
required
description
string
CreateCredentialResponse
object
id
string (uuid)
name
string
clientId
string
clientSecret
string
createdAt
string (date-time)
CredentialResponse
object
id
string (uuid)
name
string
description
string
clientId
string
isActive
boolean
permissions
array
string[]
lastUsedAt
string (date-time)
createdAt
string (date-time)
UpdateCredentialRequest
object
name
string
description
string
isActive
boolean
UpdateCredentialPermissionsRequest
object
permissions
array
string[]
required
ResetCredentialSecretResponse
object
id
string (uuid)
secret
string
- The new secret. This is the only time the secret is returned and cannot be retrieved later.
WalletResponse
object
id
string
balance
integer (int64)
TransactionListResponse
object
items
array
TransactionItem[]
TransactionItem
total
integer
TransactionItem
object
id
string
walletId
string
amount
integer (int64)
description
string
reference
string
transactionType
string
createdAt
string (date-time)
CreditUsageResponse
object
totalCredits
integer (int64)
usageByProduct
array
object[]
productCode
string
productName
string
credits
integer (int64)
count
integer
CompanyAddress
object
line1
string
required
line2
string
city
string
required
state
string
- County / state / region — optional outside US.
postalCode
string
required
country
string
required
- ISO 3166-1 alpha-2 country code (e.g. "GB").
PaymentMethod
object
id
string (uuid)
provider
string
methodType
string
displayName
string
brand
string
lastFour
string
expMonth
integer
expYear
integer
isDefault
boolean
status
string
createdAt
string (date-time)
PaymentMethodPage
object
items
array
PaymentMethod[]
PaymentMethod
total
integer
BeginAddPaymentMethodResponse
object
setupIntentId
string
required
clientSecret
string
required
CreateTopupRequest
object
paymentMethodId
string (uuid)
required
netAmount
integer (int64)
required
- Net amount (ex-VAT) in pence. Minimum £10 = 1000.
idempotencyKey
string (uuid)
required
description
string
SettleSuspensionRequest
object
paymentMethodId
string (uuid)
- Optional; defaults to the tenant's current default method.
idempotencyKey
string (uuid)
required
acknowledgeCredits
integer (int64)
- Optional sanity-check on the outstanding credits the caller believes they owe. Refused if non-zero and doesn't match the server-computed outstanding.
TopupResult
object
transactionId
string (uuid)
status
string
enum: "succeeded" | "requires_action" | "pending_external" | "failed"
providerIntentId
string
requiresActionUrl
string
failureCode
string
failureMessage
string
TopupConfiguration
object
tenantId
string (uuid)
enabled
boolean
thresholdCredits
integer (int64)
topupAmountCredits
integer (int64)
paymentMethodId
string (uuid)
cooldownSeconds
integer
lastAutoTopupAt
string (date-time)
consecutiveFailures
integer
autoDisabledAt
string (date-time)
autoDisabledReason
string
updatedAt
string (date-time)
SaveTopupConfigurationRequest
object
enabled
boolean
thresholdCredits
integer (int64)
required
- Wallet balance (in credits) below which the auto-topup fires.
topupAmountCredits
integer (int64)
required
- Credits to add on each trigger. Bounded server-side by the auto-topup limits (£20-£5000 ex-VAT in the default config).
paymentMethodId
string (uuid)
required
- Must reference an active method belonging to this tenant.
cooldownSeconds
integer
required
- Minimum seconds between consecutive auto-topups.
NotificationAlertResponse
object
id
string (uuid)
tenantId
string (uuid)
alertType
string
enum: "balance-low" | "balance-zero" | "billing-failure"- Type of billing alert
name
string
- Display name for the alert
threshold
integer (int64)
- Credit threshold that triggers the alert (minimum 10000)
cooldownMinutes
integer (int32)
- Minimum minutes between alert notifications (minimum 5)
isEnabled
boolean
- Whether the alert is active
lastTriggeredAt
string (date-time)
- When the alert was last triggered (null if never)
createdAt
string (date-time)
updatedAt
string (date-time)
NotificationAlertListResponse
object
items
array
NotificationAlertResponse[]
NotificationAlertResponse
total
integer
CreateNotificationAlertRequest
object
alertType
string
required
enum: "balance-low" | "balance-zero" | "billing-failure"- Type of billing alert
name
string
required
- Display name for the alert
threshold
integer (int64)
required
- Credit threshold that triggers the alert
cooldownMinutes
integer (int32)
required
- Minimum minutes between alert notifications
isEnabled
boolean
- Whether the alert should be active
UpdateNotificationAlertRequest
object
alertType
string
required
enum: "balance-low" | "balance-zero" | "billing-failure"- Type of billing alert
name
string
required
- Display name for the alert
threshold
integer (int64)
required
- Credit threshold that triggers the alert
cooldownMinutes
integer (int32)
required
- Minimum minutes between alert notifications
isEnabled
boolean
- Whether the alert should be active
NotificationAlertEmailResponse
object
id
string (uuid)
tenantId
string (uuid)
userId
string (uuid)
- User ID if the recipient is a tenant user
emailAddress
string (email)
- Email address if the recipient is external
createdAt
string (date-time)
updatedAt
string (date-time)
NotificationAlertEmailListResponse
object
items
array
NotificationAlertEmailResponse[]
NotificationAlertEmailResponse
total
integer
AddAlertEmailRecipientRequest
object

Either userId or emailAddress must be provided, but not both

userId
string (uuid)
- User ID to receive alerts (uses user's email)
emailAddress
string (email)
- External email address to receive alerts
NotificationAlertSmsResponse
object
id
string (uuid)
tenantId
string (uuid)
userId
string (uuid)
- User ID if the recipient is a tenant user
phoneNumber
string
- Phone number to receive SMS alerts
createdAt
string (date-time)
NotificationAlertSmsListResponse
object
items
array
NotificationAlertSmsResponse[]
NotificationAlertSmsResponse
total
integer
AddAlertSmsRecipientRequest
object
userId
string (uuid)
- User ID associated with this SMS recipient
phoneNumber
string
required
- Phone number to receive SMS alerts (E.164 format recommended)
NotificationLogResponse
object
id
string (uuid)
tenantId
string (uuid)
eventType
string
enum: "balance-low" | "balance-zero" | "billing-failure"- Type of event that triggered the notification
channel
string
enum: "email" | "sms" | "whatsapp"- Notification delivery channel
recipient
string
- Email address or phone number
status
string
enum: "sent" | "failed" | "skipped"- Delivery status
errorMessage
string
- Error message if delivery failed
createdAt
string (date-time)
NotificationLogListResponse
object
items
array
NotificationLogResponse[]
NotificationLogResponse
total
integer
nextPageToken
string
- Token for fetching the next page of results
ResolvePriceRequest
object
productCode
string
required
productFeatureCode
string
- Optional feature code to include in the price
ResolvePriceResponse
object
price
integer (int32)
- Resolved price in credits
CalculateConfigurationPriceRequest
object
productCode
string
required
- Product code to calculate price for
featureCodes
array
string[]
componentSelections
array
ComponentGroupSelectionInput[]
ComponentGroupSelectionInput
ComponentGroupSelectionInput
object
groupId
string (uuid)
required
- Component group UUID
itemIds
array
string (uuid)[]
bundleId
string (uuid)
- Selected bundle UUID (for bundle mode)
CalculateConfigurationPriceResponse
object
totalPrice
integer (int64)
- Total price in credits (10 credits = £0.01)
breakdown
PriceBreakdown
basePrice
integer (int64)
- Base product price in credits
baseIsOverride
boolean
- Whether the base price is a tenant-specific override
featurePrices
array
FeaturePriceDetail[]
componentPrices
array
ComponentGroupPriceDetail[]
PriceBreakdown
object
basePrice
integer (int64)
- Base product price in credits
baseIsOverride
boolean
- Whether the base price is a tenant-specific override
featurePrices
array
FeaturePriceDetail[]
FeaturePriceDetail
componentPrices
array
ComponentGroupPriceDetail[]
ComponentGroupPriceDetail
FeaturePriceDetail
object
featureId
string (uuid)
featureCode
string
price
integer (int64)
isOverride
boolean
- Whether this price is a tenant-specific override
ComponentGroupPriceDetail
object
groupId
string (uuid)
groupCode
string
mode
string
enum: "sum" | "bundle" | "max" | "tiered"- Pricing mode for this component group
price
integer (int64)
- Calculated price for this group
itemPrices
array
ComponentItemPriceDetail[]
ComponentItemPriceDetail
bundlePrice
ComponentBundlePriceDetail
bundleId
string (uuid)
bundleKey
string
price
integer (int64)
isOverride
boolean
- Whether this price is a tenant-specific override
ComponentItemPriceDetail
object
itemId
string (uuid)
itemCode
string
price
integer (int64)
isOverride
boolean
- Whether this price is a tenant-specific override
tier
integer (int32)
- Tier applied (1-based), only set for tiered mode
ComponentBundlePriceDetail
object
bundleId
string (uuid)
bundleKey
string
price
integer (int64)
isOverride
boolean
- Whether this price is a tenant-specific override
AccessibleProduct
object
id
string (uuid)
code
string
name
string
description
string
price
integer (int64)
- Effective price in credits (tenant override or default)
isPriceOverride
boolean
- Whether the price is a tenant-specific override
AccessibleFeature
object
id
string (uuid)
code
string
name
string
description
string
price
integer (int64)
- Effective price in credits (tenant override or default)
isPriceOverride
boolean
- Whether the price is a tenant-specific override
AccessibleComponentGroup
object
id
string (uuid)
code
string
name
string
description
string
required
boolean
- Whether selection from this group is required
multiSelect
boolean
- Whether multiple items can be selected
mode
string
enum: "sum" | "bundle" | "max" | "tiered"- Pricing mode (sum prices, use bundle price, use max price, or tiered pricing)
AccessibleComponentItem
object
id
string (uuid)
code
string
name
string
price
integer (int64)
- Effective price in credits (tenant override or default), null if no price set
isPriceOverride
boolean
- Whether the price is a tenant-specific override
tierPrices
array
ComponentItemTierPrice[]
ComponentItemTierPrice
ComponentItemTierPrice
object
tier
integer (int32)
- Tier number (1-based)
price
integer (int32)
- Price in credits for this tier
TieredPricingMatrix
object
groupId
string (uuid)
groupCode
string
groupName
string
items
array
TieredPricingMatrixItem[]
TieredPricingMatrixItem
scenarios
array
TieredPricingScenario[]
TieredPricingScenario
TieredPricingMatrixItem
object
itemId
string (uuid)
itemCode
string
itemName
string
rank
integer (int32)
- Rank based on tier-1 price descending (1 = most expensive)
hasTenantOverride
boolean
- Whether the tenant has a price override for this item
tenantOverridePrice
integer (int64)
- Tenant override price in credits, null if no override
tierPrices
array
ComponentItemTierPrice[]
ComponentItemTierPrice
TieredPricingScenario
object
itemCount
integer (int32)
- Number of items selected in this scenario
totalPrice
integer (int64)
- Total price in credits for this scenario
itemPrices
array
TieredPricingScenarioItem[]
TieredPricingScenarioItem
TieredPricingScenarioItem
object
itemId
string (uuid)
itemCode
string
tier
integer (int32)
- Tier applied to this item (1-based position)
price
integer (int64)
- Price in credits for this item in this scenario
isOverride
boolean
- Whether this price comes from a tenant override
Document
object
id
string (uuid)
tenantId
string (uuid)
documentSetId
string (uuid)
- ID of the document set this document belongs to, null if standalone
fileName
string
- Original file name
contentType
string
- MIME content type (e.g., application/pdf, image/png)
fileSize
integer (int64)
- Expected file size in bytes
status
string
enum: "pending" | "ready" | "failed"- Document status (pending = awaiting upload, ready = uploaded and confirmed)
createdAt
string (date-time)
updatedAt
string (date-time)
CreateDocumentRequest
object
fileName
string
required
- Original file name
contentType
string
required
- MIME content type
fileSize
integer (int64)
required
- Expected file size in bytes
documentSetId
string (uuid)
- Optional document set to add this document to
CreateDocumentResponse
object
id
string (uuid)
- Document ID
uploadUrl
string
- Presigned S3 PUT URL for uploading the file (expires in 15 minutes)
DocumentSet
object
id
string (uuid)
tenantId
string (uuid)
status
string
enum: "open" | "closed"
documentCount
integer (int32)
- Number of documents in this set
createdAt
string (date-time)
updatedAt
string (date-time)
Pipeline
object
id
string (uuid)
tenantId
string (uuid)
name
string
createdAt
string (date-time)
updatedAt
string (date-time)
JobHistoryEntry
object
id
string (uuid)
tenantId
string (uuid)
jobId
string (uuid)
logType
string
- Type of log entry (e.g. "information", "webhook")
url
string
method
string
statusCode
integer
content
string
requestBody
string
responseBody
string
errorMessage
string
createdAt
string (date-time)