Create a document for e-signing via Firma

POST /api/v1/documents/create

Create a document for e-signing via Firma

cURL

curl --request POST \
  --url https://api.hevn.finance/api/v1/documents/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentType": "contractor_agreement",
  "signer": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>"
  },
  "recipient": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>"
  }
}
'

import requests

url = "https://api.hevn.finance/api/v1/documents/create"

payload = {
    "documentType": "contractor_agreement",
    "signer": {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>"
    },
    "recipient": {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    documentType: 'contractor_agreement',
    signer: {firstName: '<string>', lastName: '<string>', email: '<string>'},
    recipient: {firstName: '<string>', lastName: '<string>', email: '<string>'}
  })
};

fetch('https://api.hevn.finance/api/v1/documents/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "id": "<string>",
  "firmaId": "<string>",
  "documentType": "<string>",
  "status": "<string>",
  "signerEmail": "<string>",
  "name": "<string>",
  "signingUrls": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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.

Show child attributes

recipient · FirmaSignerInfo · object · required

Signer information for a signing request.

Show child attributes

contractorAgreement · ContractorAgreementData · object | null

Data for filling Contractor Agreement template.

Show child attributes

Response

201

application/json

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[]

Show child attributes