Request schema

Two requests make a document: the document itself and, when the payment is made by card, the payment signature. The two pages of this section walk through their fields one by one, in the same shape they have inside the JSON.

How to read them

• Click a field and it opens. Inside you will find its description, when it is required, when it is used, its constraints, the values it accepts and an example JSON with the field in place.
• Fields that are objects or arrays hold their own fields one level further in, behind a thin line. Expand all and Collapse all open and close every one of them at once.
• Next to every field name there is a #: it is a link to that field, so you can send it to someone and the page opens on exactly that field.

The badges

• Required — the API rejects the request without it.
• Conditional — needed only in certain cases; the field itself names them, under "When it is required".
• Optional — you can leave it out.
• Not used by flexy — the field exists in the request and is accepted, but Flexy never reads it.

The two pages

• Document (document) — the body of POST /api/v1/documents/.
• Payment signature (signature) — the body of POST /api/v1/signatures/.