Get phone numbers allow or block list

GET

verification

management

phone-numbers

{action}

Get phone numbers allow or block list

curl --request GET \
  --url https://api.prelude.dev/v2/verification/management/phone-numbers/{action} \
  --header 'Authorization: Bearer <token>'

{
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Retrieve the phone numbers currently on your account’s allow list or block list. Use the {action} path parameter — either allow or block — to select which list to fetch. Allow list entries bypass the anti-fraud system; block list entries are rejected before a verification is ever attempted.

Access to the management API is opt-in. Contact our support team to enable it on your account. You can also edit these lists from the Verify API > Configure > Numbers tab of the Prelude dashboard. For background, see Prevent Fraud.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

action

enum<string>

required

The action type - either "allow" or "block"

Available options:

allow,

block

Response

phone_numbers

object[]

required

A list of phone numbers in the allow or block list.

Show child attributes

Add phone number to allow or block listAdd a phone number to the allow or block list. This operation is idempotent - re-adding the same phone number will not result in duplicate entries or errors. If the phone number already exists in the specified list, the operation will succeed without making any changes. In order to get access to this endpoint, contact our support team.

Get phone numbers allow or block list

curl --request GET \
  --url https://api.prelude.dev/v2/verification/management/phone-numbers/{action} \
  --header 'Authorization: Bearer <token>'

{
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}