API reference · Identity & onboarding

MSISDN Verification

GET/msisdn/verificationInitiate mobile number verification
POST/msisdn/verificationConfirm mobile number verification

GET Initiate mobile number verification

GET /msisdn/verification

Generates a 6-digit OTP valid for 10 minutes, stores it against the supplied mobile number, and dispatches it via SMS. Returns an OTP reference that must be supplied alongside the OTP on the verify call.

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Query parameters

Name	Default
`mobileNumber`	Optional

Example

Response: InitiateMsisdnVerificationResponse

curl -X GET "https://api.bridgemoni.com/msisdn/verification?mobileNumber=value" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e"
  },
  "description": "Initiate mobile number verification"
}

Responses

Status	When
`200`	Mobile number verification initiated
`409`	This mobile number has already been used to register an account holder

POST Confirm mobile number verification

POST /msisdn/verification

Validates the supplied OTP against the OTP reference returned by the initiate call. On success, the mobile number becomes eligible for account holder registration. Fails after 5 incorrect attempts or once the OTP expires (10 minutes after generation).

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Example

Request body: VerifyMsisdnOtpRequest · Response: Void

curl -X POST "https://api.bridgemoni.com/msisdn/verification" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "otp": "482913"
  }'

{
  "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "otp": "482913"
}

{
  "description": "Confirm mobile number verification"
}

Responses

Status	When
`200`	Mobile number verified successfully
`400`	The OTP does not match, or attempts exceeded
`404`	No OTP exists for the given reference
`410`	The OTP has expired

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors