Skip to main content
POST
/
v1
/
guarantors
Create a guarantor
curl --request POST \
  --url https://api.yorlet.com/v1/guarantors \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "application_status": "<string>",
  "company": {
    "name": "<string>",
    "number": "<string>"
  },
  "customer": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<string>"
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "guarantor",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "country": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "application": "<string>",
  "application_status": "<string>",
  "company": {
    "name": "<string>",
    "number": "<string>"
  },
  "contract": "<string>",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "status": "<string>",
  "account": "<string>",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
business_type
enum<string>
required

The legal type of the guarantor.

Available options:
individual,
company
​
email
string
required

The guarantor's email address.

Minimum string length: 1
​
address
object

The guarantor's address.

​
application_status
string

The ID of the applicant status to associate the guarantor with.

Pattern: ^[a-zA-Z0-9_]+$
​
company
object

Company details. Required when business_type is company.

​
customer
string

The ID of the customer the guarantor is for.

Pattern: ^[a-zA-Z0-9_]+$
​
first_name
string

The guarantor's first name.

​
last_name
string

The guarantor's last name.

​
phone
string

The guarantor's phone number.

Response

200 - application/json

Returns the created guarantor object.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
guarantor
​
address
object
required

The guarantor address.

​
application
required

The application associated with the guarantor.

​
application_status
required

The applicant status associated with the guarantor.

​
business_type
enum<string>
required

The guarantor business type.

Available options:
individual,
company
​
company
object
required

Company details when business type is company.

​
contract
required

The guarantor contract identifier.

​
email
string | null
required

The guarantor email.

​
first_name
string | null
required

The guarantor first name.

​
last_name
string | null
required

The guarantor last name.

​
name
string | null
required

The guarantor full name.

​
phone
string | null
required

The guarantor phone.

​
status
string
required

The guarantor status.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.