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>"
}
'import requests
url = "https://api.yorlet.com/v1/guarantors"
payload = {
"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>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.yorlet.com/v1/guarantors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/guarantors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/guarantors"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"application_status\": \"<string>\",\n \"company\": {\n \"name\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"customer\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/guarantors")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"application_status\": \"<string>\",\n \"company\": {\n \"name\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"customer\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/guarantors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"application_status\": \"<string>\",\n \"company\": {\n \"name\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"customer\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
}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>"
}
'import requests
url = "https://api.yorlet.com/v1/guarantors"
payload = {
"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>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};
fetch('https://api.yorlet.com/v1/guarantors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/guarantors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/guarantors"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"application_status\": \"<string>\",\n \"company\": {\n \"name\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"customer\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/guarantors")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"application_status\": \"<string>\",\n \"company\": {\n \"name\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"customer\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/guarantors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"application_status\": \"<string>\",\n \"company\": {\n \"name\": \"<string>\",\n \"number\": \"<string>\"\n },\n \"customer\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The legal type of the guarantor.
individual, company The guarantor's email address.
1The guarantor's address.
Show child attributes
Show child attributes
The ID of the applicant status to associate the guarantor with.
^[a-zA-Z0-9_]+$Company details. Required when business_type is company.
Show child attributes
Show child attributes
The ID of the customer the guarantor is for.
^[a-zA-Z0-9_]+$The guarantor's first name.
The guarantor's last name.
The guarantor's phone number.
Response
Returns the created guarantor object.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
guarantor The guarantor address.
Show child attributes
Show child attributes
The application associated with the guarantor.
The applicant status associated with the guarantor.
The guarantor business type.
individual, company Company details when business type is company.
Show child attributes
Show child attributes
The guarantor contract identifier.
The guarantor email.
The guarantor first name.
The guarantor last name.
The guarantor full name.
The guarantor phone.
The guarantor status.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Was this page helpful?