ID Templates Configuration

An ID template is a representation of a type of ID document. For more information, see ID Templates.

With Configuration as Code (CasC), you may batch configure your ID templates configuration via the API using YAML. For general information on CasC, see Configuration as Code Overview.

API Operations

CasC for ID templates supports two operations.

Requests

For general information on CasC requests such as authentication and required headers, see Configuration as Code Overview.

The following section shows sample requests using curl and basic authentication. For all examples, replace TENANT_NAME with your actual tenant name.

GET configuration

curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/iddocumenttemplates.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Authorization: Basic {auth}'

{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.

PUT configuration

curl -X PUT 'https://TENANT_NAME.mambu.com/api/configuration/iddocumenttemplates.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Content-Type: application/yaml' \
-H 'Authorization: Basic {auth}' \
--data-binary @iddocumenttemplates.yaml

{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.

“@iddocumenttemplates.yaml” represents the absolute path of the file on your device.

Use “--data-raw” if you want to specify the YAML body inline.

Configuration body example

idDocumentTemplates:
- id: "438499999"
  documentType: "Passport"
  issuingAuthority: "Government"
  documentIdTemplate: "#########"
  mandatoryForClients: false
  allowAttachments: false
- id: "662323814"
  documentType: "ID Card"
  issuingAuthority: "Government"
  documentIdTemplate: "#########"
  mandatoryForClients: true
  allowAttachments: true

Attributes

Replies

Requirements

The endpoints do not accept empty configurations or null/empty entries in a configuration.