Add phone number to allow or block list

POST

verification

management

phone-numbers

{action}

Add phone number to allow or block list

curl --request POST \
  --url https://api.prelude.dev/v2/verification/management/phone-numbers/{action} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>"
}
'

{
  "phone_number": "<string>"
}

Add a phone number to your account’s allow list or block list. Set the {action} path parameter to allow to exempt the number from anti-fraud checks, or to block to reject verifications to that number.

Access to the management API is opt-in. Contact our support team to enable it on your account. For background on when to use each list, 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

Body

application/json

phone_number

string<phone_number>

required

An E.164 formatted phone number to add to the list.

Example:

"+30123456789"

Response

Created

phone_number

string<phone_number>

required

The E.164 formatted phone number that was added to the list.

Example:

"+30123456789"

Delete phone number from allow or block listRemove a phone number from the allow or block list. This operation is idempotent - re-deleting the same phone number will not result in errors. If the phone number does not exist in the specified list, the operation will succeed without making any changes. In order to get access to this endpoint, contact our support team.