v4

OpenAPI 3.0.02026-07-314441026.8 MB

Form Types

Populate a form

Endpoint to populate form fields with the values suggested by Nmbr.

This is only possible for forms that support population.

This example uses an ROE form, but the same applies to other forms.

post/form_types/{form_type}/populate

form_typestring required

effective_datestring date required

Determines which form variant to populate. Must be a date for which a populator is configured for the given form type.

idstring

The unique identifier of the object in Nmbr.

objectstring

The type of the object in Nmbr ("form_population_result").