Skip to content

mxlabs-sg/number-verify-openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

MX Labs Open Gateway — Number Verification (OpenAPI)

The machine-readable HTTP contract for the MX Labs Open Gateway number-verification backend: silent CAMARA Number Verification with an SMS OTP fallback.

  • Spec: openapi.yaml — OpenAPI 3.1.
  • One endpoint: POST https://api.mxlab.sg/sdk.php, dispatched by an action field (start / verify / sms_send / sms_verify / ping).
  • Auth: X-API-Key header. Sandbox keys are prefixed sbx_.

Official clients

Prefer a ready-made client over generating one:

Generate a client in another language

# OpenAPI Generator (any of ~50 languages)
openapi-generator-cli generate -i openapi.yaml -g go -o ./mxlabs-go

Preview the docs

npx @redocly/cli preview-docs openapi.yaml
# or
npx @redocly/cli lint openapi.yaml

Sandbox

Sandbox keys are fully simulated — no real operator, no real SMS — and only accept the magic test numbers +10000000001 (verified), +10000000002 (→ SMS fallback), +10000000003 (not_verified). The sandbox OTP is always 000000. Ask MX Labs for a sandbox key.

License

MIT © MX Labs

About

OpenAPI 3.1 spec — MX Labs Open Gateway Number Verification (CAMARA)

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors