Reference

API reference

69 endpoints, one request shape. Every call takes an identifier and returns the same envelope — the data, and a meta.source naming the provider that answered. Base URL https://scan.judyscareagency.com/api/v1.

Get sandbox keysQuickstart & SDKs

Platform

GET/ping

Confirm a key works

GET/sources

Sources, services and live health

Credit

POST/credit/score

Credit score

Sources: credit-bureau, identity-network. Identifiers: ghana_card, bvn. Requires purpose and consentReference. Scope: credit.

Available for GH, NG

POST/credit/summary

Credit summary / bureau report

Sources: credit-bureau, identity-network. Identifiers: ghana_card, bvn. Requires purpose and consentReference. Scope: credit.

Available for GH, NG

POST/credit/repayment-history

Repayment history

Sources: credit-bureau, identity-network. Identifiers: ghana_card, bvn. Requires purpose and consentReference. Scope: credit.

Available for GH, NG

POST/credit/affordability

Affordability

Sources: credit-bureau. Identifiers: ghana_card. Requires purpose and consentReference. Scope: credit.

Available for GH

POST/credit/zw/fcb

Zimbabwe FCB credit check

Sources: identity-network. Identifiers: zw_id. Requires purpose and consentReference. Scope: credit.

Available for ZW

Identity

POST/identity/verify

Identity verify (unified)

Sources: identity-network, credit-bureau. Identifiers: ghana_card, bvn, nin. Scope: identity.

Available for ANY

POST/identity/report

Consumer identity report

Sources: credit-bureau. Identifiers: ghana_card. Scope: identity.

Available for GH

POST/identity/profile

Consumer profile detail

Sources: credit-bureau. Identifiers: ghana_card. Requires purpose and consentReference. Scope: identity.

Available for GH

POST/identity/gh/ghana-card

Ghana Card lookup

Sources: identity-network, credit-bureau. Identifiers: ghana_card. Scope: identity.

Available for GH

POST/identity/ng/bvn

BVN lookup

Sources: identity-network. Identifiers: bvn. Scope: identity.

Available for NG

POST/identity/ng/bvn/validate

BVN validate

Sources: identity-network. Identifiers: bvn. Scope: identity.

Available for NG

POST/identity/ng/nin

NIN lookup

Sources: identity-network. Identifiers: nin. Scope: identity.

Available for NG

POST/identity/gh/passport

Ghana passport lookup

Sources: identity-network. Identifiers: passport. Scope: identity.

Available for GH

POST/identity/gh/digital-address

Ghana digital address

Sources: identity-network. Identifiers: digital_address. Scope: identity.

Available for GH

POST/identity/ng/phone

Nigeria phone lookup

Sources: identity-network. Identifiers: phone. Scope: identity.

Available for NG

POST/identity/ng/age

Age & identity verification

Sources: identity-network. Identifiers: bvn, nin. Scope: identity.

Available for NG

POST/identity/ke/national-id

Kenya National ID lookup

Sources: identity-network. Identifiers: ke_national_id. Scope: identity.

Available for KE

POST/identity/ke/passport

Kenya passport lookup

Sources: identity-network. Identifiers: passport. Scope: identity.

Available for KE

POST/identity/ke/kra-pin

Kenya KRA PIN lookup

Sources: identity-network. Identifiers: kra_pin. Scope: identity.

Available for KE

POST/identity/ug/nin

Uganda NIN lookup

Sources: identity-network. Identifiers: ug_nin. Scope: identity.

Available for UG

POST/identity/ug/voter-id

Uganda voter ID lookup

Sources: identity-network. Identifiers: voter_id. Scope: identity.

Available for UG

POST/identity/ug/telco

Uganda telco subscriber lookup

Sources: identity-network. Identifiers: phone. Scope: identity.

Available for UG

POST/identity/za/national-id

South Africa National ID lookup

Sources: identity-network. Identifiers: za_id. Scope: identity.

Available for ZA

POST/identity/zm/nrc

Zambia NRC lookup

Sources: identity-network. Identifiers: nrc. Scope: identity.

Available for ZM

POST/identity/zw/national-id

Zimbabwe National ID lookup

Sources: identity-network. Identifiers: zw_id. Scope: identity.

Available for ZW

POST/identity/ao/bi

Angola BI lookup

Sources: identity-network. Identifiers: bi. Scope: identity.

Available for AO

POST/identity/uk/ekyc

United Kingdom eKYC

Sources: identity-network. Identifiers: person. Scope: identity.

Available for GB

POST/identity/ca/ekyc

Canada eKYC

Sources: identity-network. Identifiers: person. Scope: identity.

Available for CA

POST/identity/nin-slip

NIN slip

Sources: identity-network. Identifiers: nin. Scope: identity.

Available for NG

POST/identity/nin-advanced

NIN lookup (advanced)

Sources: identity-network. Identifiers: nin. Scope: identity.

Available for NG

POST/identity/nin-premium

NIN lookup (premium)

Sources: identity-network. Identifiers: nin. Scope: identity.

Available for NG

POST/address/individual

Address verification (individual)

Sources: identity-network. Identifiers: phone. Requires purpose and consentReference. Scope: address.

Available for NG

POST/address/business

Address verification (business)

Sources: identity-network. Identifiers: business. Requires purpose and consentReference. Scope: address.

Available for NG

POST/address/fetch

Address verification result

Sources: identity-network. Identifiers: reference. Scope: address.

Available for NG

POST/address/geocode

Reverse geocoding

Sources: identity-network. Identifiers: coordinates. Scope: address.

Available for ANY

Fraud & AML

POST/fraud/user

Fraud & risk screening

Sources: identity-network. Identifiers: person. Scope: fraud.

Available for ANY

POST/fraud/email

Email risk check

Sources: identity-network. Identifiers: email. Scope: fraud.

Available for ANY

POST/fraud/phone

Phone risk check

Sources: identity-network. Identifiers: phone. Scope: fraud.

Available for ANY

POST/fraud/ip

IP screening

Sources: identity-network. Identifiers: ip. Scope: fraud.

Available for ANY

POST/aml/screen

AML screening (individual)

Sources: identity-network. Identifiers: person. Scope: fraud.

Available for ANY

POST/aml/business

AML screening (business)

Sources: identity-network. Identifiers: business. Scope: fraud.

Available for ANY

Business

POST/business/cac

CAC lookup (Nigeria)

Sources: identity-network. Identifiers: business. Scope: business.

Available for NG

POST/business/tin

TIN lookup (Nigeria)

Sources: identity-network. Identifiers: business. Scope: business.

Available for NG

POST/business/identity

Business identity check

Sources: credit-bureau. Identifiers: business_reg. Scope: business.

Available for GH

POST/business/credit-summary

Business credit summary

Sources: credit-bureau. Identifiers: business_reg. Requires purpose and consentReference. Scope: business.

Available for GH

POST/business/credit-report

Business credit report

Sources: credit-bureau. Identifiers: business_reg. Requires purpose and consentReference. Scope: business.

Available for GH

POST/business/search

Global business search

Sources: identity-network. Identifiers: business. Scope: business.

Available for ANY

POST/business/ke

Kenya business lookup

Sources: identity-network. Identifiers: ke_business_reg. Scope: business.

Available for KE

POST/business/zm

Zambia business lookup

Sources: identity-network. Identifiers: zm_business_reg. Scope: business.

Available for ZM

Financial

POST/financial/resolve-account

Resolve bank account (NUBAN)

Sources: identity-network. Identifiers: account_number. Scope: financial.

Available for NG

POST/financial/account-kyc

Bank account KYC status

Sources: identity-network. Identifiers: account_number. Scope: financial.

Available for NG

Biometrics & documents

POST/biometrics/liveness

Liveness check

Sources: identity-network. Identifiers: image. Scope: biometrics.

Available for ANY

POST/biometrics/selfie-id

Photo ID + selfie match

Sources: identity-network. Identifiers: image. Scope: biometrics.

Available for ANY

POST/biometrics/selfie-bvn

BVN + selfie verification

Sources: identity-network. Identifiers: bvn. Scope: biometrics.

Available for ANY

POST/biometrics/selfie-nin

NIN + selfie verification

Sources: identity-network. Identifiers: nin. Scope: biometrics.

Available for ANY

POST/documents/analyse

Identity document analysis

Sources: identity-network. Identifiers: image. Scope: biometrics.

Available for ANY

POST/documents/ocr

Document OCR

Sources: identity-network. Identifiers: image. Scope: biometrics.

Available for ANY

POST/documents/utility-bill

Utility bill analysis

Sources: identity-network. Identifiers: image. Scope: biometrics.

Available for ANY

POST/documents/business

Business document analysis

Sources: identity-network. Identifiers: image. Scope: biometrics.

Available for ANY

POST/uploads

Stage an image or PDF for a biometric / document check

Hosted flows

GET/flows

List hosted flows

POST/flows/{flow}/sessions

Create a hosted verification session (returns the customer link)

GET/flow-sessions/{id}

Get a session and every step outcome

Messaging

POST/messaging/otp

Send OTP

Sources: identity-network. Identifiers: phone. Scope: messaging.

Available for ANY

POST/messaging/otp/validate

Validate OTP

Sources: identity-network. Identifiers: reference. Scope: messaging.

Available for ANY

Verifications

GET/verifications

List verifications

GET/verifications/{id}

Fetch one verification

Identifiers

What you look someone up by. The identifier decides which country the check runs against and, where more than one provider covers it, which one answers by default.

TypeNameCountryFormat
ghana_cardGhana CardGH/^GHA-\d{9}-\d$/i
passportPassport numberGH/^[A-Z]{1,2}\d{6,8}$/i
digital_addressGhanaPost digital addressGH/^[A-Z]{2}-\d{3,4}-\d{4}$/i
bvnBVNNG/^\d{11}$/
ninNINNG/^\d{11}$/
phonePhone number—/^\+?\d{9,15}$/
emailEmail address—/^[^@\s]+@[^@\s]+\.[^@\s]+$/
ipIP address—/^(\d{1,3}\.){3}\d{1,3}$|^[0-9a-f:]+$/i
personFull name—
businessBusiness name or RC numberNG
business_regBusiness registration numberGH
ke_business_regKenya business registration numberKE
zm_business_regZambia entity numberZM
coordinatesLatitude, longitude—/^-?\d{1,3}(\.\d+)?\s*,\s*-?\d{1,3}(\.\d+)?$/
tinTax identification numberNG/^[\d-]{8,14}$/
account_numberBank account numberNG/^\d{10}$/
documentUploaded document—
referenceReference id—
imageUploaded image—/^img_[a-z0-9]{26}$/
ke_national_idKenya National IDKE/^\d{7,9}$/
kra_pinKRA PINKE/^[AP]\d{9}[A-Z]$/i
ug_ninUganda NINUG/^[A-Z]{2}[A-Z0-9]{12,13}$/i
za_idSouth African ID numberZA/^\d{13}$/
nrcZambia NRCZM/^\d{6}\/\d{2}\/\d$/
zw_idZimbabwe National IDZW/^\d{2}-?\d{6,7}-?[A-Z]-?\d{2}$|^[A-Z0-9]{8,14}$/i
biAngola National IDAO/^[A-Z0-9]{9,20}$/i
voter_idVoter ID number—/^[A-Z0-9]{8,20}$/i

Errors

One taxonomy across every product and every provider. The code is stable and safe to branch on; the message is for a human and may change.

  • VALIDATION_ERROR
  • MISSING_API_KEY
  • INVALID_API_KEY
  • IP_NOT_ALLOWED
  • SCOPE_MISSING
  • CONSENT_REQUIRED
  • SOURCE_NOT_SUPPORTED
  • RECORD_NOT_FOUND
  • SOURCE_REJECTED
  • SOURCE_UNAVAILABLE
  • SOURCE_TIMEOUT
  • SOURCE_NOT_CONFIGURED
  • SOURCE_QUOTA_EXCEEDED
  • SERVICE_NOT_PRICED
  • INSUFFICIENT_FUNDS
  • IDEMPOTENCY_IN_PROGRESS
  • RATE_LIMITED
  • NOT_FOUND
  • INTERNAL_ERROR