Schemas

HealthResponse

status

string

RegistrationStartRequest

phoneNumber

string · required

channel

string · enum · required

Enum values:

mobile

pos

partner

partnerRef

string

RegistrationDraftResponse

draftId

string

status

string

AccountSummary

accountId

string

accountNo

string

productCode

string

status

string

CreditEligibility

eligible

boolean

maxAmount

number

reasonCodes

string[]

CreditApplicationRequest

customerId

string · required

amount

number · required

tenorDays

integer · required

CreditApplicationResponse

applicationId

string

status

string

PaymentIntentRequest

customerId

string · required

amount

number · required

currency

string · required

provider

string · enum · required

Enum values:

orange

mtn

moov

wave

PaymentIntentResponse

paymentId

string

status

string

PartnerAdminUpsertRequest

code

string · pattern: ^[a-z0-9_-]{2,64}$ · required

displayName

string · maxLength: 128 · required

legalName

string · maxLength: 160

riskTier

string

countryCodes

string[]

defaultCurrency

string · minLength: 3 · maxLength: 3

object

PartnerAdminEnvelope

success

boolean · const · required

Const value:

PartnerAdmin · required

ResponseMeta · required

PartnerAdmin

partnerId

string · uuid · required

partnerCode

string · required

displayName

string · required

status

string · required

countryCodes

string[] · required

PartnerTenantAdminUpsertRequest

tenantId

string · pattern: ^[a-z0-9_-]{2,64}$ · required

displayName

string · maxLength: 128 · required

environment

string

countryCodes

string[]

object

PartnerTenantAdminEnvelope

success

boolean · const · required

Const value:

PartnerTenantAdmin · required

ResponseMeta · required

PartnerTenantAdmin

partnerTenantId

string · uuid · required

partnerCode

string · required

tenantId

string · required

displayName

string · required

environment

string · required

status

string · required

countryCodes

string[] · required

PartnerCredentialIssueRequest

tenantId

string · required

credentialKey

string

Public credential key sent as X-API-Key-Id.

scopes

string[]

expiresAt

string · date-time

object

PartnerCredentialEnvelope

success

boolean · const · required

Const value:

PartnerCredentialIssued · required

ResponseMeta · required

PartnerCredentialIssued

partnerCode

string · required

tenantId

string · required

credentialId

string · uuid · required

credentialKey

string · required

apiKey

string · required

Raw secret returned once. Store outside git.

scopes

string[] · required

expiresAt

string · date-time · required

PartnerAccessPolicyUpsertRequest

tenantId

string · required

name

string · required

ipAllowlist

string[] · required

scopes

string[]

countryCodes

string[]

rateLimitPerMinute

integer

object

PartnerAccessPolicyEnvelope

success

boolean · const · required

Const value:

PartnerAccessPolicy · required

ResponseMeta · required

PartnerAccessPolicy

policyId

string · uuid · required

partnerCode

string · required

tenantId

string · required

name

string · required

status

string · required

ipAllowlist

string[] · required

scopes

string[] · required

countryCodes

string[] · required

PartnerUserCreateRequest

partnerUserRef

string · maxLength: 128 · required

partnerCustomerRef

string · maxLength: 128

Optional partner customer reference when the partner separates users from customers.

sourceChannel

string · maxLength: 64

countryCode

string · minLength: 2 · maxLength: 2

phoneE164

string · pattern: ^\+\d{8,15}$

object

Non-secret identity evidence captured by the partner.

object

Optional flat partner metadata for audit and support.

PartnerUserEnvelope

success

boolean · const · required

Const value:

PartnerUser · required

ResponseMeta · required

PartnerUser

partnerUserId

string · uuid · required

tenantId

string · required

partnerCode

string · required

partnerUserRef

string · required

coreLinked

boolean · required

True only when this partner-local user is already linked to a Core customer.

status

string · enum · required

Enum values:

ACTIVE

PENDING_LINK

LINKED

SUSPENDED

DISABLED

sourceChannel

string · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

partnerCustomerRef

string

customerId

string · uuid

PartnerCustomerReferenceUpsertRequest

partnerCustomerRef

string · maxLength: 128 · required

customerId

string · uuid

Existing canonical Core customer ID.

phoneE164

string · pattern: ^\+\d{8,15}$

Existing customer phone in Core mapping.

object

Optional flat partner metadata for audit and support.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: customerId
	type = object · requires: phoneE164

Properties for Variant 1:

customerId

string · uuid · required

Existing canonical Core customer ID.

partnerCustomerRef

string · maxLength: 128

phoneE164

string · pattern: ^\+\d{8,15}$

Existing customer phone in Core mapping.

object

Optional flat partner metadata for audit and support.

PartnerCustomerReferenceEnvelope

success

boolean · const · required

Const value:

PartnerCustomerReference · required

ResponseMeta · required

PartnerCustomerReference

partnerCustomerRef

string · required

customerId

string · uuid · required

customerStatus

string · required

kycLevel

string · required

status

string · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

ResponseMeta

requestId

string · required

timestamp

string · date-time · required

ErrorEnvelope

success

boolean · required

object · required

ResponseMeta · required

PartnerCreditLineListEnvelope

success

boolean · const · required

Const value:

PartnerCreditLineList · required

ResponseMeta · required

PartnerCreditLineList

partnerCustomerRef

string · required

currency

string · required

PartnerCreditLine[] · required

PartnerCreditLine

creditLineId

string · uuid · required

status

string · required

principal

string · required

outstandingBalance

string · required

termDays

integer · required

dueDate

string · date · required

disbursedAt

string · date-time · required

PartnerCreditApplicationCreateRequest

partnerCustomerRef

string · maxLength: 128 · required

principal

number · min: 10000 · max: 100000 · required

termDays

integer · min: 7 · max: 30 · required

purpose

string · maxLength: 128

PartnerCreditApplicationEnvelope

success

boolean · const · required

Const value:

PartnerCreditApplication · required

ResponseMeta · required

PartnerCreditApplication

applicationId

string · uuid · required

partnerCustomerRef

string · required

status

string · enum · required

Enum values:

PROCESSING

DISBURSED

REJECTED

PENDING_REVIEW

FAILED

requestedAmount

string · required

termDays

integer · required

creditLineId

string · uuid · required

Present when the application produced a disbursed credit line.

errorCode

string · required

Present when Core rejected or failed the application.

createdAt

string · date-time · required

updatedAt

string · date-time · required

PartnerUserCreateRequest

partnerUserRef

string · maxLength: 128 · required

partnerCustomerRef

string · maxLength: 128

Optional partner customer reference when the partner separates users from customers.

sourceChannel

string · maxLength: 64

countryCode

string · minLength: 2 · maxLength: 2

phoneE164

string · pattern: ^\+\d{8,15}$

object

Non-secret identity evidence captured by the partner.

object

Optional flat partner metadata for audit and support.

PartnerUser

partnerUserId

string · uuid · required

tenantId

string · required

partnerCode

string · required

partnerUserRef

string · required

coreLinked

boolean · required

True only when this partner-local user is already linked to a Core customer.

status

string · enum · required

Enum values:

ACTIVE

PENDING_LINK

LINKED

SUSPENDED

DISABLED

sourceChannel

string · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

partnerCustomerRef

string

customerId

string · uuid

PartnerCustomerReferenceUpsertRequest

partnerCustomerRef

string · maxLength: 128 · required

customerId

string · uuid

Existing canonical Core customer ID.

phoneE164

string · pattern: ^\+\d{8,15}$

Existing customer phone in Core mapping.

object

Optional flat partner metadata for audit and support.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: customerId
	type = object · requires: phoneE164

Properties for Variant 1:

customerId

string · uuid · required

Existing canonical Core customer ID.

partnerCustomerRef

string · maxLength: 128

phoneE164

string · pattern: ^\+\d{8,15}$

Existing customer phone in Core mapping.

object

Optional flat partner metadata for audit and support.

PartnerCreditApplication

applicationId

string · uuid · required

partnerCustomerRef

string · required

status

string · enum · required

Enum values:

PROCESSING

DISBURSED

REJECTED

PENDING_REVIEW

FAILED

requestedAmount

string · required

termDays

integer · required

creditLineId

string · uuid · required

Present when the application produced a disbursed credit line.

errorCode

string · required

Present when Core rejected or failed the application.

createdAt

string · date-time · required

updatedAt

string · date-time · required