Fulfill a requirement
Resolve an open requirement with its answers - a form, name_change or information requirement with values, a document requirement with an uploaded file by id (document, or documents for several pages). Emits requirement.fulfilled.
Authorizations
Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.
Path Parameters
ID of the requirement.
^rqmt_[0-9A-Za-z]{22}$Body
What fulfills the requirement: answers for a form, name_change or information requirement, a file for a document one. Files are uploaded first (POST /v1/files, with the purpose the requirement names) and attached here by id.
For a document requirement: the uploaded file that fulfills it, by id. Single-use.
^file_[0-9A-Za-z]{22}$For a document requirement with several pages (a passport's front and back): uploaded files, first one primary. Bounded by the purpose's policy (max_files).
5^file_[0-9A-Za-z]{22}$The answers. A name_change expects one value with key name. A form takes the keys from the requirement's form schema.
100Response
The resolved requirement.
One thing needed from you or your client: an owner's identity document, a service-order form, or something Clemta asked for (a company-name change, extra information). Fulfill it over the API, or mint a hosted link and hand fulfillment to your client.
Entity name.
requirement ^rqmt_[0-9A-Za-z]{22}$"rqmt_0346sFPEvSkJvY8vt14NNw"
The company this requirement is on.
^cmp_[0-9A-Za-z]{22}$What fulfills it. document - an identity document file. form - the current fulfilment step's answers. name_change - a new company name (a name value). information - free-form answers.
document, form, name_change, information, signature open, resolved, canceled Who opened it - the platform itself, or Clemta.
system, operations The service order this requirement belongs to - a form requirement's own order, or the order a Clemta-opened information or document ask was scoped to.
^so_[0-9A-Za-z]{22}$The owner a document requirement is about.
^sh_[0-9A-Za-z]{22}$On a document requirement: the file-policy purpose it collects under, which decides the accepted size, content types, page count and link lifetime (see the file upload guide's policy table).
identity_document, formation_document, additional_document For a signature requirement - the name of the document awaiting signature.
For a signature requirement - every party that must sign, with each one's progress. The requirement resolves only when they have all signed.
Why it was opened, in words you can show your client.
On a canceled requirement - why it closed without being fulfilled: a signer's decline reason, or Clemta withdrawing the ask. Safe to show your client.
For an OPEN form requirement: the fields to collect, read live from the fulfilment workflow.
What fulfilled it (absent for documents).
A form requirement's file-field uploads collected so far. Forwarded together with the values when the form is fulfilled.