Get policy details

Request

Returns the whole configuration of a given policyId, including multi configuration, fields, sections and attachments.

Security

OAuth2(Required scopes: read)

Path

projectIdstringrequired

Customer's project id

policyIdstringrequired

Id of the policy

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

Responses

OK

Bodyapplication/json

attachmentsArray of objects(AttachmentDefinition)

Attachment Definition

idstring

Policy Version Id

Example:"43342642354352344"

jsonPolicyobject(Policy_JsonPolicy)

policyMultiTypestring, (enum)

Indicates whether the policy accepts single or multi sender id requested in each registration process

Enum Value	Description
SINGLE	Only one sender ID is allowed per registration.
MULTI_SENDER	Up to 50 sender IDs are allowed per registration. They can be included in the senderIdDetails array (one object per sender ID)

Example:"SINGLE"

policyStatusstring, (enum)

Policy status

Enum Value	Description
ENABLED	Policy is in use.
DISABLED	Policies that for any reason has been deactivated. There are several reasons to do so, but they are mainly due to changes in the regulations, which require some manual intervention.
INACTIVE	Market version has been deactivated because a new version has been published. This policy is no longer valid.

Example:"ENABLED"

priceobject(Policy_Pricing)

isOpenPolicyboolean

Indicates if the policy has open registration system. This means that any sender ID requested is automatically approved, without any manual intervention.

statusDisclaimerstring

Contains disclaimer for disabled policies. Empty if policy is ACTIVE

Example:"Policy has been disabled as Registrations for these market conditions are now dynamic."

feesbooleandeprecated

True if policy registration has any fees associated

Response

{
  "attachments": [
    { … }
  ],
  "fees": true,
  "id": "43342642354352344",
  "jsonPolicy": {
    "companyDetailsTemplate": { … },
    "contactPersonTemplate": { … },
    "senderIdTemplate": { … },
    "marketSpecificDetailsTemplate": { … }
  },
  "policyMultiType": "SINGLE",
  "policyStatus": "ENABLED",
  "price": {
    "mode": "SUBSCRIBED",
    "subscription": { … }
  },
  "isOpenPolicy": true,
  "statusDisclaimer": "Policy has been disabled as Registrations for these market conditions are now dynamic."
}

We'd love to hear from you!