curl --request POST \
--url https://api.yorlet.com/v1/applications/{id}/applicants/{applicantId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"consumer_user_link": "<string>",
"payment_method": "<string>",
"pets": [
{
"age": 123,
"name": "<string>",
"type": "dog"
}
],
"tos_acceptance": true
}
'{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>",
"type": "dog"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}curl --request POST \
--url https://api.yorlet.com/v1/applications/{id}/applicants/{applicantId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"consumer_user_link": "<string>",
"payment_method": "<string>",
"pets": [
{
"age": 123,
"name": "<string>",
"type": "dog"
}
],
"tos_acceptance": true
}
'{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>",
"type": "dog"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}API Key authentication. Use "Bearer YOUR_API_KEY".
The id identifier.
The applicantId identifier.
The token for the consumer user link.
The identifier of the payment method to set as the default.
The pets of the applicant.
Show child attributes
The pre-qualification details for the applicant.
Show child attributes
Whether the terms of service have been accepted.
Returns the applicant object if the update succeeded.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
application.applicant The identifier of the application the applicant belongs to.
^[a-zA-Z0-9_]+$The advance rent details for the applicant.
Show child attributes
The currency for the applicant.
gbp, usd, eur, sek "gbp"
The customer associated with the applicant.
The deposit details for the applicant.
Show child attributes
The identifier of the guarantor for the applicant.
The identifier of the guarantor contract for the applicant.
The holding fee details for the applicant.
Show child attributes
Whether the applicant is the lead tenant.
Whether the applicant is a permitted occupier.
Show child attributes
The share of rent for the applicant.
The status of the applicant.
The terms of service acceptance details for the applicant.
Show child attributes
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.
The pets of the applicant.
Show child attributes
The pre-qualification details for the applicant.
Show child attributes
Was this page helpful?