Sign in
policies

Get policy details

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

get/v1/projects/{projectId}/policies/{policyId}

Path parameters

projectIdstring required

Customer's project id

policyIdstring required

Id of the policy

Response

OK

feesboolean

True if policy registration has any fees associated

idstring

Policy Version Id

policyMultiType'SINGLE' | 'MULTI_SENDER' enum

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

policyStatus'ENABLED' | 'DISABLED' | 'INACTIVE' enum

Policy status

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 response

{
  "attachments": [
    {
      "description": "This document is required for any Third party registration in MK local.",
      "id": "43342642354352344",
      "title": "Third Party Authority Form",
      "allowedMimeTypes": [
        "application/pdf",
        "application/pdf"
      ],
      "allowedDocumentTypes": [
        "Passport",
        "Driver's License"
      ]
    }
  ],
  "id": "43342642354352344",
  "jsonPolicy": {
    "companyDetailsTemplate": {
      "properties": [
        {
          "description": "Between 3 - 11 characters.\\nMust be related to the brand name.\\nMarketing SIDs are currently not allowed.",
          "x-placeholder": "e.g. name.surname@yourCompany.com",
          "maxLength": 11,
          "minLength": 3,
          "name": "senderId",
          "title": "Alphanumeric Sender ID",
          "type": "string",
          "examples": [
            "By subscribing to our loyalty program",
            "By making a purchase in-store or online"
          ],
          "pattern": "^[+][0-9]+$",
          "message": {
            "pattern": "The number needs to start with country code. For example +1",
            "maxLength": 11,
            "minLength": 3
          },
          "items": {
            "enum": [
              "+1"
            ],
            "type": "string"
          },
          "minItems": 1,
          "enum": [
            "By subscribing to our loyalty program"
          ]
        }
      ]
    },
    "contactPersonTemplate": {
      "properties": [
        {
          "description": "Between 3 - 11 characters.\\nMust be related to the brand name.\\nMarketing SIDs are currently not allowed.",
          "x-placeholder": "e.g. name.surname@yourCompany.com",
          "maxLength": 11,
          "minLength": 3,
          "name": "senderId",
          "title": "Alphanumeric Sender ID",
          "type": "string",
          "examples": [
            "By subscribing to our loyalty program",
            "By making a purchase in-store or online"
          ],
          "pattern": "^[+][0-9]+$",
          "message": {
            "pattern": "The number needs to start with country code. For example +1",
            "maxLength": 11,
            "minLength": 3
          },
          "items": {
            "enum": [
              "+1"
            ],
            "type": "string"
          },
          "minItems": 1,
          "enum": [
            "By subscribing to our loyalty program"
          ]
        }
      ]
    },
    "senderIdTemplate": {
      "properties": [
        {
          "description": "Between 3 - 11 characters.\\nMust be related to the brand name.\\nMarketing SIDs are currently not allowed.",
          "x-placeholder": "e.g. name.surname@yourCompany.com",
          "maxLength": 11,
          "minLength": 3,
          "name": "senderId",
          "title": "Alphanumeric Sender ID",
          "type": "string",
          "examples": [
            "By subscribing to our loyalty program",
            "By making a purchase in-store or online"
          ],
          "pattern": "^[+][0-9]+$",
          "message": {
            "pattern": "The number needs to start with country code. For example +1",
            "maxLength": 11,
            "minLength": 3
          },
          "items": {
            "enum": [
              "+1"
            ],
            "type": "string"
          },
          "minItems": 1,
          "enum": [
            "By subscribing to our loyalty program"
          ]
        }
      ]
    },
    "marketSpecificDetailsTemplate": {
      "properties": [
        {
          "description": "Between 3 - 11 characters.\\nMust be related to the brand name.\\nMarketing SIDs are currently not allowed.",
          "x-placeholder": "e.g. name.surname@yourCompany.com",
          "maxLength": 11,
          "minLength": 3,
          "name": "senderId",
          "title": "Alphanumeric Sender ID",
          "type": "string",
          "examples": [
            "By subscribing to our loyalty program",
            "By making a purchase in-store or online"
          ],
          "pattern": "^[+][0-9]+$",
          "message": {
            "pattern": "The number needs to start with country code. For example +1",
            "maxLength": 11,
            "minLength": 3
          },
          "items": {
            "enum": [
              "+1"
            ],
            "type": "string"
          },
          "minItems": 1,
          "enum": [
            "By subscribing to our loyalty program"
          ]
        }
      ]
    }
  },
  "policyMultiType": "SINGLE",
  "policyStatus": "ENABLED",
  "price": {
    "mode": "SUBSCRIBED"
  },
  "statusDisclaimer": "Policy has been disabled as Registrations for these market conditions are now dynamic."
}