For the complete documentation index, see llms.txt. This page is also available as Markdown.

Preverified Numbers Management

List the partner's pre-verified phone numbers

get

Returns the phone numbers in the partner's pre-verified pool. Optional query params filter by verification status and exact phone number; country_code does not filter but orders matching numbers first.

Authorizations
X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters
partner_idstringRequired

The ID of the partner.

Example: examplePA
Query parameters
code_verification_statusstring · enumOptional

Filter by verification status. When 'VERIFIED', numbers whose verification has expired on Meta's side are additionally excluded.

Example: VERIFIEDPossible values:
phone_numberstring · min: 6 · max: 20Optional

Filter by exact phone number. Digits only, no leading '+'.

Example: 15550783881Pattern: ^\d+$
country_codestringOptional

Preferred ISO 3166-1 alpha-2 country code (lowercase). Does not filter - numbers with this country code are returned first.

Example: us
Responses
200

Successful response

application/json
preverified_phone_number_idstringRequired

Meta's pre-verified phone number ID.

Example: 1234567890123456
phone_numberstringRequired

The registered phone number, digits only.

Example: 15550783881
country_codestring · nullableRequired

ISO 3166-1 alpha-2 country code (lowercase), derived from the phone number.

Example: us
partner_idstring · nullableRequired

Partner ID the number belongs to.

Example: examplePA
code_verification_statusstringRequired

Verification status of the number.

Example: NOT_VERIFIED
created_atstringRequired

ISO 8601 creation timestamp.

Example: 2026-05-26T12:34:56Z
get/api/v2/partners/{partner_id}/preverified-numbers
GET /api/v2/partners/{partner_id}/preverified-numbers HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*
[
  {
    "preverified_phone_number_id": "1234567890123456",
    "phone_number": "15550783881",
    "country_code": "us",
    "partner_id": "examplePA",
    "code_verification_status": "NOT_VERIFIED",
    "created_at": "2026-05-26T12:34:56Z"
  }
]

Add a pre-verified phone number to the partner's pool

post

Registers a phone number with Meta's Graph API and shares it with the partner's business.

Authorizations
X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters
partner_idstringRequired

The ID of the partner.

Example: examplePA
Body
phone_numberstring · min: 6 · max: 20Required

Phone number to register as pre-verified. Digits only, no leading '+'.

Example: 15550783881Pattern: ^\d+$
Responses
201

Successful response

application/json
preverified_phone_number_idstringRequired

Meta's pre-verified phone number ID.

Example: 1234567890123456
phone_numberstringRequired

The registered phone number, digits only.

Example: 15550783881
country_codestring · nullableRequired

ISO 3166-1 alpha-2 country code (lowercase), derived from the phone number.

Example: us
partner_idstring · nullableRequired

Partner ID the number belongs to.

Example: examplePA
code_verification_statusstringRequired

Verification status of the number.

Example: NOT_VERIFIED
created_atstringRequired

ISO 8601 creation timestamp.

Example: 2026-05-26T12:34:56Z
post/api/v2/partners/{partner_id}/preverified-numbers
POST /api/v2/partners/{partner_id}/preverified-numbers HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "phone_number": "15550783881"
}
{
  "preverified_phone_number_id": "1234567890123456",
  "phone_number": "15550783881",
  "country_code": "us",
  "partner_id": "examplePA",
  "code_verification_status": "NOT_VERIFIED",
  "created_at": "2026-05-26T12:34:56Z"
}

Delete a preverified phone number

delete

Deletes the number from Meta's Graph API and soft-deletes it from the partner's pre-verified pool. Returns 404 when the number is not in the pool.

Authorizations
X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters
preverified_phone_number_idstringRequired

Meta's phone number id

Example: 94986247624576
partner_idstringRequired

The ID of the partner.

Example: examplePA
Responses
200

Successful response

application/json
statusstringRequiredExample: success
messagestringRequiredExample: OTP sent.
dataany · nullableOptional
delete/api/v2/partners/{partner_id}/preverified-numbers/{preverified_phone_number_id}
DELETE /api/v2/partners/{partner_id}/preverified-numbers/{preverified_phone_number_id} HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "status": "success",
  "message": "OTP sent.",
  "data": null
}

Verify OTP for a preverified phone number

post

This endpoint is used to verify the OTP that was received for a preverified number from Meta API.

Authorizations
X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters
preverified_phone_number_idstringRequired

Meta's phone number id

Example: 94986247624576
partner_idstringRequired

The ID of the partner.

Example: examplePA
Body
codestringRequired

OTP code to verify

Example: 123456
Responses
200

Successful response

application/json
preverified_phone_number_idstringRequired

Meta's pre-verified phone number ID.

Example: 1234567890123456
phone_numberstringRequired

The registered phone number, digits only.

Example: 15550783881
country_codestring · nullableRequired

ISO 3166-1 alpha-2 country code (lowercase), derived from the phone number.

Example: us
partner_idstring · nullableRequired

Partner ID the number belongs to.

Example: examplePA
code_verification_statusstringRequired

Verification status of the number.

Example: NOT_VERIFIED
created_atstringRequired

ISO 8601 creation timestamp.

Example: 2026-05-26T12:34:56Z
post/api/v2/partners/{partner_id}/preverified-numbers/{preverified_phone_number_id}/verify-otp
POST /api/v2/partners/{partner_id}/preverified-numbers/{preverified_phone_number_id}/verify-otp HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "code": "123456"
}
{
  "preverified_phone_number_id": "1234567890123456",
  "phone_number": "15550783881",
  "country_code": "us",
  "partner_id": "examplePA",
  "code_verification_status": "NOT_VERIFIED",
  "created_at": "2026-05-26T12:34:56Z"
}

Request OTP for a preverified phone number

post

This endpoint is used to request an OTP for a preverified number from Meta API.

Authorizations
X-API-KeystringRequired

API Key for V2 authentication. Send your Partner API key in the X-API-Key header. Preferred authentication method.

Path parameters
preverified_phone_number_idstringRequired

Meta's phone number id

Example: 94986247624576
partner_idstringRequired

The ID of the partner.

Example: examplePA
Body
code_methodundefined · enumRequired

OTP delivery method

Example: smsPossible values:
languagestring · min: 1Required

Language/locale for the OTP message

Example: en_US
Responses
200

Successful response

application/json
statusstringRequiredExample: success
messagestringRequiredExample: OTP sent.
dataany · nullableOptional
post/api/v2/partners/{partner_id}/preverified-numbers/{preverified_phone_number_id}/request-otp
POST /api/v2/partners/{partner_id}/preverified-numbers/{preverified_phone_number_id}/request-otp HTTP/1.1
Host: hub.360dialog.io
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "code_method": "sms",
  "language": "en_US"
}
{
  "status": "success",
  "message": "OTP sent.",
  "data": null
}

Last updated

Was this helpful?