Skip to content
Registration API/
/Markets

Sinch Sender ID Registrations API (1.0.0)

This API describes the set of endpoints available to get each market requirements and create registration for sender IDs.

The list of endpoints allows to create, update and delete a registration and also get the current state. For each market, customers can check the different requirements depending on the new sender ID scope, and also download templates to fill in for the registrations.

Interested in this API? Please, reach out to your Account Manager for more info.

All endpoints available under this API require Bearer token authentication. Please check oauth api documentation if you need more details.
Download OpenAPI description
registrations.json
registrations.yaml
Overview
URL

https://www.sinch.com

Support

Support@sinch.com

License

MIT

Languages
Servers
Production server

https://senderid.registrations.api.sinch.com/

Staging server

https://senderid.numbers-registration.staging.sinch.com/

Callback configuration

You can set up callback URLs to receive event notifications when your registration status is updated. When delivering events the order is not guaranteed (for example, a failed event scheduled for retry will not block other events that were queued). The client's callback handler must implement the state machine that can decide what to do with unexpected events, for example, "old" events or invalid state transitions. In these cases the handler could use the API to GET the latest state for the resource. The callback handler is expected to "ingest" the event and respond with 200 OK. The domain-specific business logic and processes should be executed outside of the callback request, as internal asynchronous jobs. An HMAC encrypted secret is used for hashing the payload and sending the hashed String via the X-Sinch-Signature header - that you can use to validate that an incoming request is secure. Hmac secret value can be checked with GET endpoint, and it can be updated with PUT endpoint

Operations

Markets

Operations related to get market availability and different options based on usage

Operations

Get market codes list

Request

The endpoint retrieves the list of market codes available for alphanumeric registration. Market code is an optional query param, if used, the response will contain a list with the same market code if it is available; the list will be empty if it is not.

Security
OAuth2
Path
projectIdstringrequired

Customer's project id

Query
marketCodestring^[A-Z]{2}$

Filter by ISO market code (ex. 'IT', 'AU', 'KW', etc.)

Example: marketCode=MK
languagestring^[a-z]{2}$

Language used to print country names. Default: en

Example: language=es
registrationTypestring(enum)

Type of Sender ID to be registered. Options: ALPHANUMERIC_SENDER_ID for alpha registration, LONG_NUMBER for long number sms services registration, SHORT_CODE for short code sms services registration, RCS_AGENT for RCS agent

Default "ALPHANUMERIC_SENDER_ID"
Enum ValueDescription
ALPHANUMERIC_SENDER_ID

Alpha sender IDs

LONG_NUMBER

Long Numbers for SMS

SHORT_CODE

Short Codes for SMS

RCS_AGENT

RCS agent

curl -i -X GET \
  'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/markets/availability?marketCode=MK&language=es&registrationType=ALPHANUMERIC_SENDER_ID' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
marketsArray of objects(MarketDescription)

List of countries that matches with the request criteria.

Response
application/json
{
  "markets": [
    { … }
  ]
}

Get market versions

Request

The endpoint will return the markets in active status according to the query parameters: market code and registration type

Security
OAuth2
Path
projectIdstringrequired

Customer's project id

Query
marketCodestring^[A-Z]{2}$

Filter by ISO market code (ex. 'IT', 'AU', 'KW', etc.)

Example: marketCode=MK
activePoliciesboolean

Filter to enable viewing only active policies in markets. Default: false, returns all policies within market

Default false
pageTokenstring

Add token from previous query if needed to retrieve more markets

pageSizeinteger(int32)

Number of markets per page

registrationTypestring(enum)

Type of Sender ID to be registered. Options: ALPHANUMERIC_SENDER_ID for alpha registration, LONG_NUMBER for long number sms services registration, SHORT_CODE for short code sms services registration, RCS_AGENT for RCS agent

Default "ALPHANUMERIC_SENDER_ID"
Enum ValueDescription
ALPHANUMERIC_SENDER_ID

Alpha sender IDs

LONG_NUMBER

Long Numbers for SMS

SHORT_CODE

Short Codes for SMS

RCS_AGENT

RCS agent

curl -i -X GET \
  'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/markets/details?marketCode=MK&activePolicies=false&pageToken=string&pageSize=0&registrationType=ALPHANUMERIC_SENDER_ID' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
marketVersionsArray of objects(MarketVersion)

List of Market versions that matches with the request criteria.

nextPageTokenstring

next token to be used to retrieve more markets

Example: "CgptYXJrZXRDb2RlEk4KRnR5cGUuZ29vZ2xlYXBpcy5jb20vc2luY2gubnVtcmVnLnBvbGljeS52MWFscGhhMi5NYXJrZXRWZXJzaW9uUGFnZU1hcmsSBAoCS1o="
totalSizeinteger(int32)

Total Number of markets.

Example: 50
Response
application/json
{
  "marketVersions": [
    { … }
  ],
  "nextPageToken": "CgptYXJrZXRDb2RlEk4KRnR5cGUuZ29vZ2xlYXBpcy5jb20vc2luY2gubnVtcmVnLnBvbGljeS52MWFscGhhMi5NYXJrZXRWZXJzaW9uUGFnZU1hcmsSBAoCS1o=",
  "totalSize": 50
}

Policies

Operation related to get policy required information, as fields, validations or attachments

Operations

Registrations

Submit, update, list and get registration info.

Operations