Guarantor Form

Template Overview

Template ID: guarantor-form
Version: 2.0.0

To generate this document, pass the structured data described below into the data property of the /api/v1/documents/generate endpoint.

Data Payload Schema

Field	Type	Requirement	Description & Details
`employeeName`	`string`	No	Employee Full name Please use the full name, as is on the passport or any other official documents of the party.
`role`	`string`	No	Employee Role
`guarantorName`	`string`	No	Guarantor Full name
`guarantorAddress`	`string`	No	Address (number & street)
`guarantorPhoneNumber`	`number`	No	Guarantor Phone Number
`country`	`string`	No	Country Must be a valid value from the Supported Countries list.

Example JSON Payload

Here is an example of a properly formatted data object for the Guarantor Form template.

{
  "templateId": "guarantor-form",
  "data": {
    "employeeName": "Sample Employee Name",
    "role": "Sample Role",
    "guarantorName": "Sample Guarantor Name",
    "guarantorAddress": "123 Beta Way, Lagos",
    "guarantorPhoneNumber": 1,
    "country": "Nigeria"
  },
  "format": "pdf"
}