API Reference

Configure template

post
https://example.com/onboarding/v2/templates//configure

Configure a template for a country, document type, and business model combination.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The identifier of the template to configure

Body Params
string

Business model this mapping applies to (optional)

Validations:

  • Must be one of: b2b, b2c, b2g
string
required

ISO 3166-1 alpha-2 country code (case-insensitive; stored uppercase)

Validations:

  • Required property
  • Length ({{.actual}}) must be {{.max}} characters long.
  • Country code must be ISO 3166-1 alpha-2.
string
required

Transaction type this mapping applies to. Same values as transactions/v1 type (FULL, RECEIPT, SIMPLIFIED, ...). Case-insensitive.

Validations:

  • Required property
  • Must be a valid transaction type.
Responses

401

Authentication failed - missing or incorrect subscription key.

404

Template with the provided template_id was not found.

429

Too many requests were sent for a short period of time. Try again a bit later.

Updated 20 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago

Did this page help you?