registrations

Get registration

The endpoint receives as path param project id and registration id. If the registration exists under the specified project id, the details of the registration are returned.

get/v1/projects/{projectId}/registrations/{registrationId}

Path parameters

projectIdstring required

Customer's project id

registrationIdstring required

Id of the registration

Response

callbackUrlstring

Webhook URL to specify an endpoint for delivery of notifications about registration updates

createTimestring

Creation time of the request. ISO date time format in UTC without timezone offset.

etaDatestring

Expected date of the registration approval. ISO date format.

idstring

Unique registration identifier.

notificationContactsstring[]

Email addresses that will be notified of any status changes of the registration.

ownerstring

Display name of the user that created the registration.

policyIdstring

Unique identifier of the policy for this registration.

registrationType'ALPHANUMERIC_SENDER_ID' | 'LONG_NUMBER' | 'SHORT_CODE' | 'RCS_AGENT' enum

Specify the sender ID type

senderIdsstring[]

List of sender IDs associated with this registration. If sender IDs are not provided in the request, they will be assigned after registration approval.

Status of the registration.

tagsstring[]

User tags used for the registration. Tag have to start from '#' and contains only alphanumerics and dashes.

updateTimestring

Update time of the request. ISO date time format in UTC without timezone offset.

servicePlanIdstring

Service plan ID or System ID that the registration applies to. When included, the sender id will be configured linked to the service/system plan.

Example response

{
  "attachments": [
    {
      "attachmentId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee",
      "createTime": "2021-11-03T14:30:03",
      "fileName": "sender_id_registration_form.docx",
      "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "updateTime": "2021-11-03T14:30:03",
      "uploadStatus": "COMPLETED",
      "documentType": "Passport"
    }
  ],
  "callbackUrl": "senderid.registrations.api.sinch.com",
  "createTime": "2021-11-03T14:30:03",
  "etaDate": "2024-11-03",
  "id": "d1c7ccbf-919d-462f-8587-dec95a1b11ee",
  "logs": [
    {
      "createTime": "2021-11-03T14:30:03",
      "message": "Please update the attachment connected to your request.",
      "registrationState": "PENDING"
    }
  ],
  "notificationContacts": [
    "jane.doe@example.com",
    "john.doe@example.com"
  ],
  "owner": "Jane Doe",
  "policyId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee",
  "price": {
    "currency": "USD",
    "frequency": 1,
    "mode": "SUBSCRIBED",
    "recurrentFeeAmount": "2",
    "setupFeeAmount": "5"
  },
  "registrationType": "ALPHANUMERIC_SENDER_ID",
  "requestDetails": [
    {
      "additionalDetails": [
        {
          "email": "email@mycompany.com"
        },
        {
          "companyName": "My Company Name",
          "website": "https://www.mycompany.com"
        }
      ],
      "senderIdDetails": [
        {
          "sender": "a sender value"
        }
      ]
    }
  ],
  "senderIds": [
    "senderId1",
    "senderId2"
  ],
  "status": "IN_QUEUE",
  "tags": [
    "#myTag1",
    "#myTag2"
  ],
  "updateTime": "2021-11-03T14:30:03",
  "servicePlanId": "a23dccbf-919d-462f-8587-dec95a1b44de"
}