Policies

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

Get policy details

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

SecurityOAuth2

Request

path Parameters

projectId required	string Customer's project id
policyId required	string Id of the policy

Responses

200

Response Schema: application/json

Array of objects (AttachmentDefinition)

Attachment Definition

fees

boolean

Deprecated

True if policy registration has any fees associated

string

Policy Version Id

object (Policy_JsonPolicy)

policyMultiType

string <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)

policyStatus

string <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.

object (Policy_Pricing)

isOpenPolicy

boolean

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

statusDisclaimer

string

Contains disclaimer for disabled policies. Empty if policy is ACTIVE

404

NOT_FOUND: Policy Id introduced does not exist.

500

INTERNAL: Internal server error. Typically, a server bug.

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

Request samples

Node.js
C#
Java
Python
curl

Response samples

application/json

{"attachments": [{"description": "This document is required for any Third party registration in MK local.",
"id": "43342642354352344",
"mandatory": true,
"template": true,
"title": "Third Party Authority Form"
}
],
"fees": true,
"id": "43342642354352344",
"jsonPolicy": {"companyDetailsTemplate": {"properties": [{"description": "Between 3 - 11 characters.\\nMust be related to the brand name.\\nMarketing SIDs are currently not allowed.",
"maxLength": 11,
"minLength": 3,
"name": "senderId",
"required": false,
"title": "Alphanumeric Sender ID",
"type": "string",
"examples": ["By subscribing to our loyalty program",
"By making a purchase in-store or online"
],
"enum": ["PROMOTIONAL",
"TRANSACTIONAL",
"OTP",
"MULTIUSE"
],
"pattern": "^[+][0-9]+$",
"message": {"pattern": "The number needs to start with country code. For example +1",
"maxLength": 11,
"minLength": 3
}
}
]
},
"contactPersonTemplate": {"properties": [{"description": "Between 3 - 11 characters.\\nMust be related to the brand name.\\nMarketing SIDs are currently not allowed.",
"maxLength": 11,
"minLength": 3,
"name": "senderId",
"required": false,
"title": "Alphanumeric Sender ID",
"type": "string",
"examples": ["By subscribing to our loyalty program",
"By making a purchase in-store or online"
],
"enum": ["PROMOTIONAL",
"TRANSACTIONAL",
"OTP",
"MULTIUSE"
],
"pattern": "^[+][0-9]+$",
"message": {"pattern": "The number needs to start with country code. For example +1",
"maxLength": 11,
"minLength": 3
}
}
]
},
"senderIdTemplate": {"properties": [{"description": "Between 3 - 11 characters.\\nMust be related to the brand name.\\nMarketing SIDs are currently not allowed.",
"maxLength": 11,
"minLength": 3,
"name": "senderId",
"required": false,
"title": "Alphanumeric Sender ID",
"type": "string",
"examples": ["By subscribing to our loyalty program",
"By making a purchase in-store or online"
],
"enum": ["PROMOTIONAL",
"TRANSACTIONAL",
"OTP",
"MULTIUSE"
],
"pattern": "^[+][0-9]+$",
"message": {"pattern": "The number needs to start with country code. For example +1",
"maxLength": 11,
"minLength": 3
}
}
]
},
"marketSpecificDetailsTemplate": {"properties": [{"description": "Between 3 - 11 characters.\\nMust be related to the brand name.\\nMarketing SIDs are currently not allowed.",
"maxLength": 11,
"minLength": 3,
"name": "senderId",
"required": false,
"title": "Alphanumeric Sender ID",
"type": "string",
"examples": ["By subscribing to our loyalty program",
"By making a purchase in-store or online"
],
"enum": ["PROMOTIONAL",
"TRANSACTIONAL",
"OTP",
"MULTIUSE"
],
"pattern": "^[+][0-9]+$",
"message": {"pattern": "The number needs to start with country code. For example +1",
"maxLength": 11,
"minLength": 3
}
}
]
}
},
"policyMultiType": "SINGLE",
"policyStatus": "ENABLED",
"price": {"mode": "SUBSCRIBED",
"subscription": {"currency": "string",
"frequency": 0,
"recurrentFeeAmount": "string",
"setupFeeAmount": "string"
}
},
"isOpenPolicy": true,
"statusDisclaimer": "Policy has been disabled as Registrations for these market conditions are now dynamic."
}

Download policy template file

Download a policy template. Use this enpdoint to download the template for those policy attachments which template value is true.

SecurityOAuth2

Request

path Parameters

projectId required	string Customer's project id Example: eeew32344324edewe2e3
policyId required	string Policy id requested Example: 43342642354352344
attachmentId required	string Attachment definition id requested Example: 324234762423034240

Responses

200

Request Successful with binary file returned in octet stream

Response Schema: application/octet-stream

string <binary>

404

Policy/template not found

get/v1/projects/{projectId}/policies/{policyId}/attachments/{attachmentId}/template

Request samples

Node.js
C#
Java
Python
curl

Response samples

application/json

{"error": {"code": 0,
"details": [{ }
],
"message": "string",
"status": "string"
}
}

Security Privacy Legal & Compliance Cookie Statement