Developer Center

Document Templates API

Last Updated: Feb 20, 2017 04:30PM CET

URL

/api/settings/iddocumenttemplates

Description

Allows the retrieval of information about the document templates. This is especially useful when creating clients which require an ID document and the template key needs to be provided.

Methods

GET IDDocumentTemplates

Get a list of valid document templates in the organisation.

Usage examples

// Get all the document templates in the current organisation
GET /api/settings/iddocumenttemplates

Response

A 200 OK response will be issued with a list of templates.
[
    {
    "encodedKey": "40298a134700d849014700d872fd000f",
    "documentType": "Reispass",
    "issuingAuthority": "Bundesrepublik Deutschland",
    "documentIdTemplate": "####@###$###@",
    "mandatoryForClients": "true",
    "allowAttachments": "true"
    },
    {
    "encodedKey": "ab74ccd134700d849014700d872fd000f",
    "documentType": "Identity Card",
    "issuingAuthority": "Spain",
    "documentIdTemplate": "#########@@@",
    "mandatoryForClients": "false",
    "allowAttachments": "false"
    }
]
support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete