BridgeUser Verification
- POST
/user/{emailAddress}/verify/emailConfirm email address verification - POST
/user/{emailAddress}/verify/email/initiateInitiate email address verification - POST
/user/{msisdn}/verify/msisdnConfirm mobile number verification - POST
/user/{msisdn}/verify/msisdn/initiateInitiate mobile number verification
POST Confirm email address verification
POST /user/{emailAddress}/verify/email
Validates the supplied OTP against the most recently generated one for this user's email address. On success, marks the email address as verified. 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 |
Path parameters
| Name |
|---|
emailAddress |
Example
Request body: VerifyOtpRequest · Response: Void
curl -X POST "https://api.bridgemoni.com/user/ada%40example.com/verify/email" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" \
-H "Content-Type: application/json" \
-d '{
"otp": "482913"
}'{
"otp": "482913"
}{
"description": "Confirm email address verification"
}Responses
| Status | When |
|---|---|
200 | Email address verified successfully |
400 | The OTP does not match, or has expired |
404 | No user exists for the given email address, or no OTP has been generated for it |
POST Initiate email address verification
POST /user/{emailAddress}/verify/email/initiate
Generates a 6-digit OTP valid for 10 minutes, stores it against the user's email address, and publishes an OtpGeneratedEvent so it can be dispatched via email. Does not return the OTP in the response.
Headers
| Name | Notes |
|---|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
| Name |
|---|
emailAddress |
Example
Response: Void
curl -X POST "https://api.bridgemoni.com/user/ada%40example.com/verify/email/initiate" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"{
"description": "Initiate email address verification"
}Responses
| Status | When |
|---|---|
200 | Email address verification initiated successfully |
404 | No user exists for the given email address |
POST Confirm mobile number verification
POST /user/{msisdn}/verify/msisdn
Validates the supplied OTP against the most recently generated one for this user's mobile number. On success, marks the mobile number as verified. 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 |
Path parameters
| Name |
|---|
msisdn |
Example
Request body: VerifyOtpRequest · Response: Void
curl -X POST "https://api.bridgemoni.com/user/%2B2348012345678/verify/msisdn" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV" \
-H "Content-Type: application/json" \
-d '{
"otp": "482913"
}'{
"otp": "482913"
}{
"description": "Confirm mobile number verification"
}Responses
| Status | When |
|---|---|
200 | Mobile number verified successfully |
400 | The OTP does not match, or has expired |
404 | No user exists for the given reference, or no OTP has been generated for it |
POST Initiate mobile number verification
POST /user/{msisdn}/verify/msisdn/initiate
Generates a 6-digit OTP valid for 10 minutes, stores it against the user's mobile number, and publishes an OtpGeneratedEvent so it can be dispatched via SMS. Does not return the OTP in the response.
Headers
| Name | Notes |
|---|---|
Authorization | Bearer token |
X-Tenant | Your tenant |
X-Environment | test or live |
Path parameters
| Name |
|---|
msisdn |
Example
Response: Void
curl -X POST "https://api.bridgemoni.com/user/%2B2348012345678/verify/msisdn/initiate" \
-H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
-H "X-Tenant: $BRIDGEMONI_TENANT" \
-H "X-Environment: $BRIDGEMONI_ENV"{
"description": "Initiate mobile number verification"
}Responses
| Status | When |
|---|---|
200 | Mobile number verification initiated successfully |
404 | No user exists for the given reference |
Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors