Skip to content

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.

Download OpenAPI description
Overview
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

Request

The endpoint receives as path param project id. If the project exists, the details of the callback configuration are returned.

Security
OAuth2
Path
projectIdstringrequired

Customer's project id

curl -i -X GET \
  'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/callback-configuration' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
hmacSecretstring

The HMAC secret used for hashing the callback body using the HMAC-SHA1 algorithm - and for creating the X-Sinch-Signature header.

Example: "d1c7ccbf-919d-462f-8587-dec95a1b11ee"
projectIdstring
Response
application/json
{ "hmacSecret": "d1c7ccbf-919d-462f-8587-dec95a1b11ee", "projectId": "string" }

Request

The endpoint updates the callback configuration with specified project ID

Security
OAuth2
Path
projectIdstringrequired

Customer's project id

Bodyapplication/json
hmacSecretstring

The HMAC secret to be updated for the specified project

Example: "d1c7ccbf-919d-462f-8587-dec95a1b11ee"
curl -i -X PUT \
  'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/callback-configuration' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "hmacSecret": "d1c7ccbf-919d-462f-8587-dec95a1b11ee"
  }'

Responses

OK

Bodyapplication/json
hmacSecretstring

The HMAC secret used for hashing the callback body using the HMAC-SHA1 algorithm - and for creating the X-Sinch-Signature header.

Example: "d1c7ccbf-919d-462f-8587-dec95a1b11ee"
projectIdstring
Response
application/json
{ "hmacSecret": "d1c7ccbf-919d-462f-8587-dec95a1b11ee", "projectId": "string" }

Markets

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

Operations

Policies

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

Operations

Registrations

Submit, update, list and get registration info.

Operations