Skip to main content
POST
/
api
/
v1
/
documents
/
create
Create a document for e-signing via Firma
curl --request POST \
  --url https://api.hevn.finance/api/v1/documents/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "signer": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>"
  },
  "recipient": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>"
  }
}
'
{
  "id": "<string>",
  "firmaId": "<string>",
  "documentType": "<string>",
  "status": "<string>",
  "signerEmail": "<string>",
  "name": "<string>",
  "signingUrls": []
}

Authorizations

​
Authorization
string
header
default:Bearer <token>
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-key
string | null

Body

application/json

Request to create a document for signing via Firma.

​
documentType
enum<string>
required

Supported document types for e-signing.

Available options:
contractor_agreement
​
signer
FirmaSignerInfo · object
required

Signer information for a signing request.

​
recipient
FirmaSignerInfo · object
required

Signer information for a signing request.

​
contractorAgreement
ContractorAgreementData · object

Data for filling Contractor Agreement template.

Response

Successful Response

Response after creating and sending a signing request.

​
id
string
required
​
firmaId
string
required
​
documentType
string
required
​
status
string
required
​
signerEmail
string
required
​
name
string | null
​
signingUrls
FirmaSigningUrlInfo · object[]