Create a proof

post

https://api.sandbox.helloaria.eu/companies/{companyId}/proofs

Creates a proof. Every proof carries a file uploaded beforehand through the Upload file endpoint, .json included. Pass targets to link the proof in the same call, or omit it and link it later.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

string

required

Defaults to me

Body Params

type

string

enum

required

What the proof establishes. Each type is accepted on specific targets only, and a type sent on a target that refuses it returns INVALID_PROOF_TYPE. OTHER is accepted everywhere and requires a label. UNKNOWN is migration-only and cannot be posted. See the Proof guide for the type per target.

fileId

string

required

Id of a file uploaded first through the Upload file endpoint. Structured evidence is uploaded as a .json file, like a PDF or an image, and validated against the schema declared for type.

label

string

Free-text description of what the document is. Required when type is OTHER, optional otherwise.

targets

array of objects

Targets to link this proof to in the same call. Omit to create a proof with no target yet and link it afterwards through POST /companies/{companyId}/proofs/{proofId}/link.

targets

Headers

x-end-user-ip

string

IP of the end-user doing the action resulting in the API call.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successfully created proof

400Invalid payload, including a proof of type: OTHER sent with no label.

403Not permitted (e.g trying to create a proof for a company other than yours)

409DUPLICATE_PROOF: the same fileId is already linked to one of the given targets

422INVALID_PROOF_TYPE if type is not legal on one of the given targets. INVALID_PROOF_FILE if fileId does not exist or belongs to another company, or if a .json proof does not match the schema declared for its type. An INVOICE_BREAKDOWN only needs to be valid JSON.