--- title: "Get policy details" method: GET path: "/v1/projects/{projectId}/policies/{policyId}" tags: ["policies"] --- # Get policy details `GET /v1/projects/{projectId}/policies/{policyId}` Returns the whole configuration of a given policyId, including multi configuration, fields, sections and attachments. ## Path parameters - `projectId` string, required - `policyId` string, required ## Response `200` OK - Policy — Policy response, contains the fields and attachments required, multi type configuration, status and fees - `attachments` AttachmentDefinition[] — Attachment Definition - `description` string — Attachment description - `id` string — Attachment Definition Id - `mandatory` boolean — whether the attachment is mandatory in this policy - `template` boolean — Whether the attachment contains a template or not. Templates can be downloaded with /template endpoint - `title` string — Attachment title - `allowedMimeTypes` string[] — Array of allowed mime types. If empty, no restrictions are applied. - `allowedDocumentTypes` string[] — Document types allowed for this attachment. If specified, the documentType field in the attachment must be one of the allowed types. - `fees` boolean — True if policy registration has any fees associated - `id` string — Policy Version Id - `jsonPolicy` PolicyJsonPolicy - `companyDetailsTemplate` object — Policy section related to company details - `properties` PolicyJsonPolicyProperty[] - `description` string — Description of the field - `x-placeholder` string — Placeholder text shown in the field when it is empty. An example of what should be entered in the field - `maxLength` integer — Max length of text field - `minLength` integer — Min length of text field - `name` string — Name of the field. Serves as a key (reference) to a field - `required` boolean — Indicator that specifies whether a field is optional or required - `title` string — Name of field shown in user interface. In some cases, there is a question for which an answer is expected in the field - `type` 'string' | 'array' — Type of field. Possible types are 'string' - for a simple text field or enum or 'array' - for multiple texts in one field - `examples` string[] — Used as suggestions for possible response in the field - `pattern` string — Regex pattern validation - `message` object — Pattern validation message - `pattern` string — Pattern validation message - `maxLength` integer — Max length of the field value - `minLength` integer — Min length of the field value - `items` object — When the field type is 'array', this object describes the array items. Typically a checkbox. Contains an enum when the array items are restricted to a set of values. - `enum` union — Possible values for the array items - string[] - integer[] - `type` 'string' | 'integer' — Type of the array items. Possible types are 'string' or 'integer' - `minItems` integer — Minimum number of items selected when the field type is 'array' - `enum` union — Possible values for the field when the field type is not an array. Typically a dropdown. In some cases the enum contains true and null. This is for mandatory checks according to market regulations. - string[] - integer[] - boolean[] — This can be a true false option or a true checkbox, that contains [true, null] as options - `contactPersonTemplate` object — Policy section related to contact person details - `properties` PolicyJsonPolicyProperty[] - `description` string — Description of the field - `x-placeholder` string — Placeholder text shown in the field when it is empty. An example of what should be entered in the field - `maxLength` integer — Max length of text field - `minLength` integer — Min length of text field - `name` string — Name of the field. Serves as a key (reference) to a field - `required` boolean — Indicator that specifies whether a field is optional or required - `title` string — Name of field shown in user interface. In some cases, there is a question for which an answer is expected in the field - `type` 'string' | 'array' — Type of field. Possible types are 'string' - for a simple text field or enum or 'array' - for multiple texts in one field - `examples` string[] — Used as suggestions for possible response in the field - `pattern` string — Regex pattern validation - `message` object — Pattern validation message - `pattern` string — Pattern validation message - `maxLength` integer — Max length of the field value - `minLength` integer — Min length of the field value - `items` object — When the field type is 'array', this object describes the array items. Typically a checkbox. Contains an enum when the array items are restricted to a set of values. - `enum` union — Possible values for the array items - string[] - integer[] - `type` 'string' | 'integer' — Type of the array items. Possible types are 'string' or 'integer' - `minItems` integer — Minimum number of items selected when the field type is 'array' - `enum` union — Possible values for the field when the field type is not an array. Typically a dropdown. In some cases the enum contains true and null. This is for mandatory checks according to market regulations. - string[] - integer[] - boolean[] — This can be a true false option or a true checkbox, that contains [true, null] as options - `senderIdTemplate` object — Policy section related to sender ID details - `properties` PolicyJsonPolicyProperty[] - `description` string — Description of the field - `x-placeholder` string — Placeholder text shown in the field when it is empty. An example of what should be entered in the field - `maxLength` integer — Max length of text field - `minLength` integer — Min length of text field - `name` string — Name of the field. Serves as a key (reference) to a field - `required` boolean — Indicator that specifies whether a field is optional or required - `title` string — Name of field shown in user interface. In some cases, there is a question for which an answer is expected in the field - `type` 'string' | 'array' — Type of field. Possible types are 'string' - for a simple text field or enum or 'array' - for multiple texts in one field - `examples` string[] — Used as suggestions for possible response in the field - `pattern` string — Regex pattern validation - `message` object — Pattern validation message - `pattern` string — Pattern validation message - `maxLength` integer — Max length of the field value - `minLength` integer — Min length of the field value - `items` object — When the field type is 'array', this object describes the array items. Typically a checkbox. Contains an enum when the array items are restricted to a set of values. - `enum` union — Possible values for the array items - string[] - integer[] - `type` 'string' | 'integer' — Type of the array items. Possible types are 'string' or 'integer' - `minItems` integer — Minimum number of items selected when the field type is 'array' - `enum` union — Possible values for the field when the field type is not an array. Typically a dropdown. In some cases the enum contains true and null. This is for mandatory checks according to market regulations. - string[] - integer[] - boolean[] — This can be a true false option or a true checkbox, that contains [true, null] as options - `marketSpecificDetailsTemplate` object — Only available for RCS Agent policies. This section shows some market specific requirements, while others are general for all markets. - `properties` PolicyJsonPolicyProperty[] - `description` string — Description of the field - `x-placeholder` string — Placeholder text shown in the field when it is empty. An example of what should be entered in the field - `maxLength` integer — Max length of text field - `minLength` integer — Min length of text field - `name` string — Name of the field. Serves as a key (reference) to a field - `required` boolean — Indicator that specifies whether a field is optional or required - `title` string — Name of field shown in user interface. In some cases, there is a question for which an answer is expected in the field - `type` 'string' | 'array' — Type of field. Possible types are 'string' - for a simple text field or enum or 'array' - for multiple texts in one field - `examples` string[] — Used as suggestions for possible response in the field - `pattern` string — Regex pattern validation - `message` object — Pattern validation message - `pattern` string — Pattern validation message - `maxLength` integer — Max length of the field value - `minLength` integer — Min length of the field value - `items` object — When the field type is 'array', this object describes the array items. Typically a checkbox. Contains an enum when the array items are restricted to a set of values. - `enum` union — Possible values for the array items - string[] - integer[] - `type` 'string' | 'integer' — Type of the array items. Possible types are 'string' or 'integer' - `minItems` integer — Minimum number of items selected when the field type is 'array' - `enum` union — Possible values for the field when the field type is not an array. Typically a dropdown. In some cases the enum contains true and null. This is for mandatory checks according to market regulations. - string[] - integer[] - boolean[] — This can be a true false option or a true checkbox, that contains [true, null] as options - `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 - `price` PolicyPricing - `mode` 'SUBSCRIBED' | 'MANUAL' | 'NONE', enum — Type of policy pricing. - `subscription` PricingSubscription - `currency` string — Currency of user - `frequency` integer — Frequency of recurrent fee, is 0 when there is not recurrent fee. The number ranges from 0 to 12, where 1 indicates monthly payments and 12 indicates yearly payments - `recurrentFeeAmount` string — Amount of recurrent fee - `setupFeeAmount` string — Amount of setup fee - `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 ## Other responses - `404` — NOT_FOUND: Policy Id introduced does not exist. - `500` — INTERNAL: Internal server error. Typically, a server bug. --- [API](https://skmtc.net/sinch/apis/sinch-sender-id-registrations-api.md) · [All operations](https://skmtc.net/sinch/apis/sinch-sender-id-registrations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/sinch-sender-id-registrations-api/revisions/e93587db2688/schema)