Sign in
Brands

Verify Brand SMS OTP

Verify the SMS OTP (One-Time Password) for Sole Proprietor brand verification.

Verification Flow:

  1. User receives OTP via SMS after triggering
  2. User submits the OTP pin through this endpoint
  3. Upon successful verification:
    • A BRAND_OTP_VERIFIED webhook event is sent to the CSP
    • The brand's identityStatus changes to VERIFIED
    • Campaigns can now be created for this brand

Error Handling:

Provides proper error responses for:

  • Invalid OTP pins
  • Expired OTPs
  • OTP verification failures
put/10dlc/brand/{brandId}/smsOtp

Path parameters

brandIdstring required
Example:4b20019b-043a-78f8-0657-b3be3f4b4002

The Brand ID for which to verify the OTP

Request body

otpPinstring required

The OTP PIN received via SMS

Example request

{
  "otpPin": "123456"
}

Response

OTP verified successfully - No content returned

Changes

Changed in 3 of the 99 revisions of this API.312

  • a6a61a29ecdd11See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1571b0380bd711See the full diff
    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e53799411See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.