Skip to main content
GET
Retrieve a requirement

Authorizations

Authorization
string
header
required

Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.

Path Parameters

requirementID
string
required

ID of the requirement.

Pattern: ^rqmt_[0-9A-Za-z]{22}$

Response

200 - application/json

The 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.

object
enum<string>
required

Entity name.

Available options:
requirement
id
string
required
Pattern: ^rqmt_[0-9A-Za-z]{22}$
Example:

"rqmt_0346sFPEvSkJvY8vt14NNw"

company
string
required

The company this requirement is on.

Pattern: ^cmp_[0-9A-Za-z]{22}$
type
enum<string>
required

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.

Available options:
document,
form,
name_change,
information,
signature
status
enum<string>
required
Available options:
open,
resolved,
canceled
requested_by
enum<string>
required

Who opened it - the platform itself, or Clemta.

Available options:
system,
operations
livemode
boolean
required
created_at
string<date-time>
required
service_order
string

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.

Pattern: ^so_[0-9A-Za-z]{22}$
shareholder
string

The owner a document requirement is about.

Pattern: ^sh_[0-9A-Za-z]{22}$
purpose
enum<string>

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).

Available options:
identity_document,
formation_document,
additional_document
document_name
string

For a signature requirement - the name of the document awaiting signature.

signers
object[]

For a signature requirement - every party that must sign, with each one's progress. The requirement resolves only when they have all signed.

message
string

Why it was opened, in words you can show your client.

cancel_reason
string

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.

form
object

For an OPEN form requirement: the fields to collect, read live from the fulfilment workflow.

response
object[]

What fulfilled it (absent for documents).

attachments
object[]

A form requirement's file-field uploads collected so far. Forwarded together with the values when the form is fulfilled.

resolved_at
string<date-time>