FOfonoa
Onboarding

Configure document template

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

post/onboarding/v2/templates/{template_id}/configure

Request

  • The document declares no server URL.
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

template_idstring required

The identifier of the document template to configure

Request body

business_modelstring

Business model this mapping applies to. Use UNSPECIFIED or omit the field to match any business model.

Validations:

  • Must be one of: b2b, b2c, b2g, unspecified
country_codestring required

ISO 3166-1 alpha-2 country code (case-insensitive; stored uppercase), or ** to match any country

Validations:

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

Transaction type this mapping applies to. Use UNSPECIFIED to match any transaction type. Case-insensitive.

Validations:

  • Required property
  • Must be a valid transaction type.

Response

Ok - document template configuration was saved successfully.

messagestring
statusstring

The status of the request.

Example response

{
  "errors": [
    {
      "type": "validation"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.