# REST API — Sender ID


Source: https://vertexsms.com/en/api/senderid

The name of your company, brand, or customer-support number is displayed as the sender on outgoing messages.

## Register an alphanumeric sender

Request:

```
POST /senderId HTTP/1.1
Host: api.vertexsms.com
Content-Type: application/json
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh

{ "name": "TestSender", "type": "AlphaNumeric", "category": "Other", "categoryDescription": "Some description", "notificationUrl": "http://client.com/senderIdCallBack" }
```

Response:

```
HTTP/1.1 200 OK
Content-Type: plain/text
Cache-control: no-cache

123
```

On success returns `200 OK` and the new sender's numeric ID (e.g. `123`).

Parameters:

| Field | Type | Description |
|-------|------|-------------|
| name | string | Sender name, 3–11 characters. Standard alphanumeric (upper/lower) recommended. The symbols `- _ & # !` are accepted but some operators do not display them correctly. |
| type | string | `AlphaNumeric` (for this flow). |
| category | string | One of `Company`, `Product`, `Brand`, `Shortcode`, `Landline`, `Other`. |
| categoryDescription | string | Comments / description shown to the reviewer. Required for sender-name verification. |
| notificationUrl | string | Webhook URL for sender-status notifications. |

## Register a mobile number as a sender

Your mobile number is displayed as a sender so recipients can reply to you.

Request:

```
POST /senderId HTTP/1.1
Host: api.vertexsms.com
Content-Type: application/json
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh

{ "name": "37069555555", "type": "MSISDN" }
```

Response: `200 OK` + the new sender ID.

You then receive a 5-digit PIN by SMS. Confirm the sender with that PIN:

```
POST /senderId/confirm/123 HTTP/1.1
Host: api.vertexsms.com
Content-Type: application/json
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh

{ "code": "12345" }
```