Schemas

DataSourceRequest

tenant_id

string · required

partner_code

string · required

source_code

string · required

owner

string · required

ingestion_mode

string · required

is_active

boolean · required

consent_basis

string

trust_level

integer

IngestionJobRequest

tenant_id

string · required

partner_code

string · required

data_source_code

string · required

payload_ref

string · required

source_format

string · required

status

string · enum · required

Enum values:

RECEIVED

ACCEPTED

REJECTED

FAILED

received_at

string · date-time · required

idempotency_key

string · required

object · required

source_event_id

string

SubjectObservationRequest

tenant_id

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

partner_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

source_system

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_.-]+$ · required

external_subject_ref

string · maxLength: 255 · required

Partner-local person reference. Four partners can each have their own ref for the same real person.

observation_type

string · enum · required

Enum values:

gps_position

transaction

profile

payment_habit

device

account

custom

observed_at

string · date-time · required

idempotency_key

string · maxLength: 1000 · required

Stable key for this exact observation. Reuse with changed payload should conflict.

object · required

GPS point, transaction, profile, payment habit, device, account, or custom scoring fact.

data_source_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$

Defaults to source_system + observation_type.

received_at

string · date-time

source_event_id

string · maxLength: 255

payload_ref

string · maxLength: 1000

object

BatchFileIngestionRequest

tenant_id

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

partner_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

data_source_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

file_uri

string · maxLength: 1000 · required

Object storage URI, signed upload reference, or internal file id. Do not paste binary file content here.

file_name

string · maxLength: 255 · required

file_format

string · enum · required

Enum values:

csv

xlsx

xls

json

idempotency_key

string · maxLength: 1000 · required

source_event_id

string · maxLength: 255

period_start

string · date-time

period_end

string · date-time

row_count

integer · min: 0 · max: 100000000

schema_version

string · maxLength: 100

received_at

string · date-time

object

SubjectLinkRequest

tenant_id

string · required

partner_code

string · required

canonical_subject_id

string · required

Canonical MobiCred subject. For credit execution, this resolves to the one Core/Fineract person.

source_system

string · required

external_subject_ref

string · required

match_confidence

number · min: 0 · max: 1 · required

object · required

Non-secret evidence such as core_customer_id, partner_customer_ref, phone verification, or operator case reference.

linked_at

string · date-time · required

verification_status

string · enum

Enum values:

VERIFIED

PENDING_REVIEW

REJECTED

LEGACY_UNVERIFIED

verification_source

string

FeatureSnapshotRequest

tenant_id

string · required

partner_code

string · required

subject_id

string · required

feature_set_version

string · required

computed_at

string · date-time · required

object · required

freshness_days

integer · required

FeatureSnapshotFromIngestionRequest

ingestion_job_id

string · uuid · required

feature_set_version

string · required

EvaluateScoreDecisionRequest

tenant_id

string · required

partner_code

string · required

feature_snapshot_id

string · uuid · required

product_code

string · required

requested_amount

number · required

object

max_snapshot_age_days

integer

PartnerScoreSubject

source_system

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_.-]+$ · required

System that introduced the subject, such as partner code, mobile, POS, or telco feed.

external_subject_ref

string · maxLength: 255 · required

Partner-local subject reference in the source system. The service resolves this through a verified subject link.

PartnerScoreRequest

tenant_id

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

partner_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

idempotency_key

string · maxLength: 255 · required

Partner or gateway supplied key. Reusing it with different payload data returns a conflict.

product_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

requested_amount

number · min: 1 · max: 1000000000000000 · required

PartnerScoreSubject · required

feature_set_version

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_.-]+$ · required

object · minProps: 1 · required

Normalized or raw scoring features, including payment habits, inflow, demographics, and location/zone signals.

data_source_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$

Default: partner-score-api

payload_ref

string · maxLength: 1000

Non-secret payload reference for audit and support.

source_event_id

string · maxLength: 255

source_format

string · maxLength: 100

Default: json

object

Non-secret source summary, address, economics, transaction summary, or provider metadata.

received_at

string · date-time

country

string · pattern: ^[A-Z]{2}$

currency

string · pattern: ^[A-Z]{3}$

channel

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$

Default: partner-api

max_snapshot_age_days

integer · min: 0 · max: 365

Default: 30

ScoreDecisionResponse

id

string · uuid · required

tenantid

string · required

partnercode

string · required

subjectid

string · required

productcode

string · required

requestedamount

number · required

decisionrequesthash

string · required

Stable hash used to replay equivalent score requests.

score

integer · min: 0 · max: 1200 · required

band

string · required

modelversion

string · required

object · required

featuresnapshotid

string · uuid · required

decidedat

string · date-time · required

object

Includes handoff.can_execute_credit and handoff.execution_status. score_only means the standalone scoring result is usable, but Core/Fineract execution is not ready until the canonical customer/account link exists.

isActive

boolean

createdAt

string · date-time

updatedAt

string · date-time

ScoringAdminOverview

generated_at

string · date-time

object

PaginationMeta

total

integer

page

integer

limit

integer

totalPages

integer

hasNextPage

boolean

hasPreviousPage

boolean

SearchReindexResult

indexed

integer

Number of database rows replayed to Elasticsearch.

batches

integer

Number of database batches processed.

batch_size

integer

Effective batch size used for the DB-to-search replay.

search_indexing_enabled

boolean

Whether Elasticsearch indexing is enabled in service config.

SearchSyncStatus

generated_at

string · date-time

search_indexing_enabled

boolean

source_of_truth

string

object

SearchSyncRetryResult

generated_at

string · date-time

source_of_truth

string

object

ScoreDecisionPage

ScoreDecisionResponse[]

PaginationMeta

ScoringDashboardSummary

generated_at

string · date-time

object

object[]

ScoringDashboardFacets

generated_at

string · date-time

object

ScoringGeoAggregates

generated_at

string · date-time

object

object[]

ScoringGeoIntelligence

generated_at

string · date-time

object

source_of_truth

string

search_usage

string

object

Declares which filters apply to each composed panel.

object

ScoringSubjectDetail

generated_at

string · date-time

object

ScoringAdminSession

generated_at

string · date-time

object

ScoringAdminNotifications

generated_at

string · date-time

object

unread_count

integer

object

object[]

ScoringReviewActionResult

generated_at

string · date-time

source_of_truth

string · enum

Enum values:

postgres

object

ScoreDecisionResponse

ReferenceDataPage

object[]

object

DataSourceQualitySummary

object

object[]

ErrorResponse

error

string

statusCode

integer

PartnerSubjectRequest

partnerCustomerRef

string · required

phoneNumber

string · required

object

IngestionJobRequest

tenant_id

string · required

partner_code

string · required

data_source_code

string · required

payload_ref

string · required

source_format

string · required

status

string · enum · required

Enum values:

RECEIVED

ACCEPTED

REJECTED

FAILED

received_at

string · date-time · required

idempotency_key

string · required

object · required

source_event_id

string

SubjectObservationRequest

tenant_id

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

partner_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

source_system

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_.-]+$ · required

external_subject_ref

string · maxLength: 255 · required

Partner-local person reference. Four partners can each have their own ref for the same real person.

observation_type

string · enum · required

Enum values:

gps_position

transaction

profile

payment_habit

device

account

custom

observed_at

string · date-time · required

idempotency_key

string · maxLength: 1000 · required

Stable key for this exact observation. Reuse with changed payload should conflict.

object · required

GPS point, transaction, profile, payment habit, device, account, or custom scoring fact.

data_source_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$

Defaults to source_system + observation_type.

received_at

string · date-time

source_event_id

string · maxLength: 255

payload_ref

string · maxLength: 1000

object

BatchFileIngestionRequest

tenant_id

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

partner_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

data_source_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

file_uri

string · maxLength: 1000 · required

Object storage URI, signed upload reference, or internal file id. Do not paste binary file content here.

file_name

string · maxLength: 255 · required

file_format

string · enum · required

Enum values:

csv

xlsx

xls

json

idempotency_key

string · maxLength: 1000 · required

source_event_id

string · maxLength: 255

period_start

string · date-time

period_end

string · date-time

row_count

integer · min: 0 · max: 100000000

schema_version

string · maxLength: 100

received_at

string · date-time

object

SubjectLinkRequest

tenant_id

string · required

partner_code

string · required

canonical_subject_id

string · required

Canonical MobiCred subject. For credit execution, this resolves to the one Core/Fineract person.

source_system

string · required

external_subject_ref

string · required

match_confidence

number · min: 0 · max: 1 · required

object · required

Non-secret evidence such as core_customer_id, partner_customer_ref, phone verification, or operator case reference.

linked_at

string · date-time · required

verification_status

string · enum

Enum values:

VERIFIED

PENDING_REVIEW

REJECTED

LEGACY_UNVERIFIED

verification_source

string

PartnerScoreSubject

source_system

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_.-]+$ · required

System that introduced the subject, such as partner code, mobile, POS, or telco feed.

external_subject_ref

string · maxLength: 255 · required

Partner-local subject reference in the source system. The service resolves this through a verified subject link.

PartnerScoreRequest

tenant_id

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

partner_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

idempotency_key

string · maxLength: 255 · required

Partner or gateway supplied key. Reusing it with different payload data returns a conflict.

product_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$ · required

requested_amount

number · min: 1 · max: 1000000000000000 · required

PartnerScoreSubject · required

feature_set_version

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_.-]+$ · required

object · minProps: 1 · required

Normalized or raw scoring features, including payment habits, inflow, demographics, and location/zone signals.

data_source_code

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$

Default: partner-score-api

payload_ref

string · maxLength: 1000

Non-secret payload reference for audit and support.

source_event_id

string · maxLength: 255

source_format

string · maxLength: 100

Default: json

object

Non-secret source summary, address, economics, transaction summary, or provider metadata.

received_at

string · date-time

country

string · pattern: ^[A-Z]{2}$

currency

string · pattern: ^[A-Z]{3}$

channel

string · maxLength: 100 · pattern: ^[a-zA-Z0-9_-]+$

Default: partner-api

max_snapshot_age_days

integer · min: 0 · max: 365

Default: 30

ScoreDecisionResponse

id

string · uuid · required

tenantid

string · required

partnercode

string · required

subjectid

string · required

productcode

string · required

requestedamount

number · required

decisionrequesthash

string · required

Stable hash used to replay equivalent score requests.

score

integer · min: 0 · max: 1200 · required

band

string · required

modelversion

string · required

object · required

featuresnapshotid

string · uuid · required

decidedat

string · date-time · required

object

isActive

boolean

createdAt

string · date-time

updatedAt

string · date-time

ScoringGeoIntelligence

generated_at

string · date-time

object

source_of_truth

string

search_usage

string

object

Declares which filters apply to each composed panel.

object