Skip to main content
POST
Add Guarantor

Overview

Adds a guarantor to the loan. The guarantor will receive an invitation via the clientPath link to complete their form. This step is optional unless required by the underwriting decision.

Request

Method: POST
URL: /v1/loans/:applicationId/guarantor

Parameters

Request Body

Response

201 Created

Error Responses

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Path Parameters

applicationId
string
required

Body

application/json

Provide the required values for the request body.

first_name
string
required
Example:

"John"

last_name
string
required
Example:

"Doe"

phone
string
required
Example:

"08012345678"

email
string
required
Example:

"guarantor@example.com"

Response

200 - application/json

Successful response

The response is of type object.