RentProfile API documentation

Last updated: October 8th, 2020

Overview

Introduction

We offer REST API’s for trusted organisations looking to create more integrated, customised experiences.

Definitions

Request ID (request_id) - a unique identifier of the Tenant/Guarantor Check request, this is automatically assigned when the check request is initially submitted and will be returned in the response.

Combined (combined) - indicator for if the affordability should be calculated from the total rent for all the applicants of the same rental address, rather than individually (only applies to renters).

Landlord AML ID (landlord_aml_id) - a unique static identifier (set by you) for each user you wish to run a Landlord AML Check on.

Our API's



Invite API

The Invite API replicates making a Tenant or Guarantor Check request in our Agent Dashboard.

This is a post based json rest api, for it to work you need to include your api key in your post request (you can apply for this here) as well as the parameters listed below you wish to check against.

  • "api_key"
  • "address_line1"
  • "postcode"
  • "rent_per_person"
  • "applicant_name"
  • - then at least one of these parameters listed below -
  • "applicant_email"
  • "applicant_mobile"
  • - optional parameters listed below -
  • "branch_id"
  • "combined"
  • "total_rent"
  • "client_name"
  • "client_type"
  • "client_email"
  • "client_phone"

Note: Up to 10 applicants can be invited at once, use the applicant_is_guarantor_for option if the applicant is a guarantor.

If the request has been made on behalf of a client then "client_name", "client_email", "client_phone", "client_type" (for example: "landlord" or "agent") can be optionally provided.

Invite API Method

The request type is POST

Invite API Data Params

Invite API Request Data Param Types
{
    api_key : [string],
    branch_id : [string],
    address_line1 : [string],
    postcode : [string],
    combined : [string],
    total_rent : [string],
    rent_per_person : [string],
    applicant_name : [string],
    applicant_email : [string],
    applicant_mobile : [string],
    applicant_is_guarantor_for : [string],
    applicant_name_2 : [string],
    applicant_email_2 : [string],
    applicant_mobile_2 : [string],
    applicant_is_guarantor_for_2 : [string],
    applicant_name_3 : [string],
    applicant_email_3 : [string],
    applicant_mobile_3 : [string],
    applicant_is_guarantor_for_3 : [string],
    applicant_name_4 : [string],
    applicant_email_4 : [string],
    applicant_mobile_4 : [string],
    applicant_is_guarantor_for_4 : [string],
    applicant_name_5 : [string],
    applicant_email_5 : [string],
    applicant_mobile_5 : [string],
    applicant_is_guarantor_for_5 : [string],
    applicant_name_6 : [string],
    applicant_email_6 : [string],
    applicant_mobile_6 : [string],
    applicant_is_guarantor_for_6 : [string],
    applicant_name_7 : [string],
    applicant_email_7 : [string],
    applicant_mobile_7 : [string],
    applicant_is_guarantor_for_7 : [string],
    applicant_name_8 : [string],
    applicant_email_8 : [string],
    applicant_mobile_8 : [string],
    applicant_is_guarantor_for_8 : [string],
    applicant_name_9 : [string],
    applicant_email_9 : [string],
    applicant_mobile_9 : [string],
    applicant_is_guarantor_for_9 : [string],
    applicant_name_10 : [string],
    applicant_email_10 : [string],
    applicant_mobile_10 : [string],
    applicant_is_guarantor_for_10 : [string],
    client_name : [string],
    client_type : [string],
    client_email : [string],
    client_phone : [string]
}
Invite API Request Data Params Example
{
    "api_key":"longrandomstringforapikey123456",
    "branch_id":"71",
    "address_line1":"32 London Bridge Street",
    "postcode":"SE1 9SG",
    "combined":"true",
    "total_rent":"£2000",
    "rent_per_person":"£1000",
    "applicant_name":"Anna Stevens",
    "applicant_email":"example@renter.com",
    "applicant_mobile":"07123456789",
    "applicant_name_2":"Tom Smith",
    "applicant_email_2":"example2@renter.com",
    "applicant_name_3":"Jane Smith",
    "applicant_email_3":"example@guarantor.com",
    "applicant_mobile_3":"07987654321",
    "applicant_is_guarantor_for_3":"Tom Smith"
}
Invite API Response Data Param Types
{
    applicant_name : [string],
    request_id : [string],
    applicant_name_2 : [string],
    request_id_2 : [string],
    applicant_name_3 : [string],
    request_id_3 : [string],
    applicant_name_4 : [string],
    request_id_4 : [string],
    applicant_name_5 : [string],
    request_id_5 : [string],
    applicant_name_6 : [string],
    request_id_6 : [string],
    applicant_name_7 : [string],
    request_id_7 : [string],
    applicant_name_8 : [string],
    request_id_8 : [string],
    applicant_name_9 : [string],
    request_id_9 : [string],
    applicant_name_10 : [string],
    request_id_10 : [string]
}
Invite API Response Data Params Example
{
   "applicant_name":"Anna Stevens",
   "request_id":"3d51225d80",
   "applicant_name_2":"Tom Smith",
   "request_id_2":"837y4uie34",
   "applicant_name_3":"Jane Smith",
   "request_id_3":"d4jvrow237"
}

Multiple Request ID's (request_id, request_id_2, request_id_3 etc.) will be in the response if multiple applicants are submitted at the same time.

Invite API Endpoint

https://www.rentprofile.co/v1/api/invite/request
Invite API Request Example
curl -H "Content-Type: application/json" -X POST -d '{"branch_id":"71","address_line1":"32 London Bridge Street","postcode":"SE1 9SG","rent_per_person":"£1000","combined":"true","total_rent":"£2000","applicant_name":"Anna Stevens","applicant_email":"example@renter.com","applicant_mobile":"07123456789","applicant_name_2":"Tom Smith","applicant_email_2":"example2@renter.com","applicant_name_3":"Jane Smith","applicant_email_3":"example@guarantor.com","applicant_mobile_3":"07987654321","applicant_is_guarantor_for_3":"Tom Smith","api_key":"replace_this_with_your_api_key"}' https://www.rentprofile.co/v1/api/invite/request
Invite API Response Example
{"applicant_name":"Anna Stevens","request_id":"3d51225d80","applicant_name_2":"Tom Smith","request_id_2":"837y4uie34","applicant_name_3":"Jane Smith","request_id_3":"d4jvrow237"}

Status API

The Status API replicates the status in our Agent Dashboard displaying the progress of the Tenant or Guarantor Check.

This is a post based json rest api, for it to work you need to include your api key in your post request (you can apply for this here) as well as the parameters listed below you wish to check against.

  • "api_key"
  • - then at least one of these parameters listed below -
  • "request_id"
  • "branch_id" - coming soon
  • "name" - coming soon
  • "address_line1" and "postcode" - coming soon

Status API Method

The request type is POST

Status API Data Params

Status API Request Data Param Types
{
    api_key : [string],
    request_id  : [string]
}
Status API Request Data Params Example
{
    "api_key":"longrandomstringforapikey123456",
    "request_id":"3d51225d80"
}
Status API Response Data Param Types
{
    request_id : [string],
    status : [string],
    branch_id : [string],
    address : [string],
    name : [string],
    email_address : [string],
    mobile : [string],
    renter_or_guarantor : [string],
    invite_date : [string],
    profile_link : [string]
}
Status API Response Data Params Example
{
   "request_id":"3d51225d80",
   "status":"Complete",
   "branch_id":"71",
   "address":"32 London Bridge Street, London, SE1 9SG",
   "name":"Anna Stephens",
   "email_address":"example@renter.com",
   "mobile":"07123456789",
   "renter_or_guarantor":"renter",
   "invite_date":"24/09/2018",
   "profile_link":"https://www.rentprofile.co/r/examplerenter"
}

Notes on responses:
status responses can be "Waiting on applicant", "Waiting on co-applicants", "In review", "Waiting on refs & ID", "Waiting on references", "Waiting on landlord ref & ID", "Waiting on workplace ref & ID", "Waiting on earnings & ID", "Waiting on landlord reference", "Waiting on workplace reference", "Waiting on earnings", "Waiting on ID", "Processing", "Complete"

The url to the profile (profile_link) will only be returned if the Status is Complete

Status API Endpoint

https://www.rentprofile.co/v1/api/status/request
Status API Request Example
$ curl -H "Content-Type: application/json" -X POST -d '{"request_id":"3d51225d80","api_key":"replace_this_with_your_api_key"}' https://www.rentprofile.co/v1/api/status/request
Status API Response Example
{"request_id":"3d51225d80","status":"Complete","branch_id":"71","address":"32 London Bridge Street, London, SE1 9SG","name":"Anna Stephens","email_address":"example@renter.com","mobile":"07123456789","renter_or_guarantor":"renter","invite_date":"24/09/2018","profile_link":"https://www.rentprofile.co/r/examplerenter"}

Status API Demo

You can use the request id 3d51225d80 to try the Status API.




Result API

The Result API replicates the information provided in a Tenant or Guarantor Check Report.

This is a post based json rest api, for it to work you need to include your api key in your post request (you can apply for this here) as well as the parameters listed below you wish to check against.

  • "api_key"
  • - then at least one of these parameters listed below -
  • "request_id"
  • "name" - coming soon
  • - optional parameters listed below -
  • "pdf_required"

Result API Method

The request type is POST

Result API Data Params

Result API Request Data Param Types
{
    api_key : [string],
    request_id  : [string],
    pdf_required  : [string]
}
Result API Request Data Params Example
{
    api_key : "longrandomstringforapikey123456",
    request_id  : "3d51225d80",
    pdf_required  :  "true"
}

- If you would like the PDF to be generated and the link to it provided in the response, set pdf_required as "true".

Result API Response Data Param Types
{
    request_id : [string],
    branch_id : [string],
    address : [string],
    processed_date : [string],
    combined : [string],
    rent_upfront : [string],
    months_upfront : [string],
    rent_amount : [string],
    affordability : [string],
    ownership : [string],
    profile_link : [string],
    name : [string],
    email_address : [string],
    mobile : [string],
    thumbnail : [string],
    ccj : [string],
    bankruptcy : [string],
    credit_file_adverse_findings : [string],
    identity : [string],
    pets : [string],
    dependents : [string],
    right_to_rent : [string],
    employment_type : [string],
    employment_term : [string],
    employer : [string],
    job_title : [string],
    position : [string],
    probation : [string],
    start_month : [string],
    start_year : [string],
    workplace_manager_verified : [string],
    type_of_self_employed_company : [string],
    extra_self_employed_info : [string],
    registered_since : [string],
    strike_actions : [string],
    business_ccj : [string],
    director : [string],
    accountant_verified : [string],
    salary : [string],
    uk_bank_account : [string],
    risk_score : [string],
    renter_or_guarantor : [string],
    not_provided : [string],
    first_rental : [string],
    landlord_or_agent_name : [string],
    rental_dates : [string],
    rent_on_time : [string],
    property_in_good_condition : [string],
    no_rent_arrears : [string],
    recommend : [string],
    landlord_or_agent_name_2 : [string],
    rental_dates_2 : [string],
    rent_on_time_2 : [string],
    property_in_good_condition_2 : [string],
    no_rent_arrears_2 : [string],
    recommend_2 : [string],
    landlord_or_agent_name_3 : [string],
    rental_dates_3 : [string],
    rent_on_time_3 : [string],
    property_in_good_condition_3 : [string],
    no_rent_arrears_3 : [string],
    recommend_3 : [string],
    landlord_or_agent_name_4 : [string],
    rental_dates_4 : [string],
    rent_on_time_4 : [string],
    property_in_good_condition_4 : [string],
    no_rent_arrears_4 : [string],
    recommend_4 : [string],
    landlord_or_agent_name_5 : [string],
    rental_dates_5 : [string],
    rent_on_time_5 : [string],
    property_in_good_condition_5 : [string],
    no_rent_arrears_5 : [string],
    recommend_5 : [string],
    pdf_url : [string]
}
Result API Response Data Params Example
{
   "request_id":"3d51225d80",
   "branch_id":"71",
   "address":"32 London Bridge Street, London, SE1 9SG",
   "processed_date":"25/09/2018",
   "combined":"true",
   "rent_upfront":"false",
   "rent_amount":"£2,000",
   "affordability":"£2450",
   "profile_link":"https://www.rentprofile.co/r/examplerenter",
   "name":"Anna Stevens",
   "email_address":"example@renter.com",
   "mobile":"0712345****",
   "status":"Complete",
   "thumbnail":"https://s3-eu-west-1.amazonaws.com/rentprofile/tenantprofile/profile/eugyih/eugyih.jpg",
   "ccj":"pass",
   "bankruptcy":"pass",
   "credit_file_adverse_findings":"pass",
   "identity":"pass",
   "pets":"false",
   "dependents":"false",
   "right_to_rent":"true",
   "employment_type":"Employed",
   "employment_term":"Permanent",
   "employer":"Gulbenkian Andonian Solicitors",
   "job_title":"Trainee Solicitor",
   "position":"Full-time",
   "probation":"No",
   "start_month":"May",
   "start_year":"2016",
   "workplace_manager_verified":"true",
   "salary":"£32,000",
   "uk_bank_account":"true",
   "risk_score":"Low Risk",
   "renter_or_guarantor":"renter",
   "not_provided":"false",
   "first_rental":"false",
   "landlord_or_agent_name":"Michael T",
   "rental_dates":"July 2018 until January 2019",
   "rent_on_time":"true",
   "property_in_good_condition":"true",
   "no_rent_arrears":"true",
   "recommend":"true",
   "pdf_url":"https://rentprofile-reports.s3-eu-west-1.amazonaws.com/example/3d51225d80_examplerenter.pdf"
}

- The amount of months upfront will be in the response as months_upfront only if rent_upfront is true.
- Up to the most recent 5 previous agent/landlord recommendations will be provided in the response.
- Only relevant employment details will be in the response e.g. if self-employed with a limited company then registered_since, strike_actions, business_ccj and director will be included.
- Access to the pdf_url respository will be locked down to the whitelisted IP address(es) provided the by the API user (the example above is set as public).
- Due to generating the latest PDF it may take up to 5 seconds for the document to be uploaded to the PDF url path.

Result API Endpoint

https://www.rentprofile.co/v1/api/result/request
Result API Request Example
$ curl -H "Content-Type: application/json" -X POST -d '{"request_id":"3d51225d80","pdf_required":"true","api_key":"replace_this_with_your_api_key"}' https://www.rentprofile.co/v1/api/result/request
Result API Response Example
{"request_id":"3d51225d80","branch_id":"71","address":"32 London Bridge Street, London, SE1 9SG","processed_date":"25/09/2018","combined":"true","rent_upfront":"false","rent_amount":"£2,000","affordability":"£2450","profile_link":"https://www.rentprofile.co/r/examplerenter","name":"Anna Stevens","email_address":"example@renter.com","mobile":"0712345****","status":"Complete","thumbnail":"https://s3-eu-west-1.amazonaws.com/rentprofile/tenantprofile/profile/eugyih/eugyih.jpg","ccj":"pass","bankruptcy":"pass","credit_file_adverse_findings":"pass","identity":"pass","pets":"false","dependents":"false","right_to_rent":"true","employment_type":"Employed","employment_term":"Permanent","employer":"Gulbenkian Andonian Solicitors","job_title":"Trainee Solicitor","position":"Full-time","probation":"No","start_month":"May","start_year":"2016","workplace_manager_verified":"true","salary":"£32,000","uk_bank_account":"true","risk_score":"Low Risk","renter_or_guarantor":"renter","not_provided":"false","first_rental":"false","landlord_or_agent_name":"Michael T","rental_dates":"July 2018 until January 2019","rent_on_time":"true","property_in_good_condition":"true","no_rent_arrears":"true","recommend":"true","pdf_url":"https://rentprofile-reports.s3-eu-west-1.amazonaws.com/example/3d51225d80_examplerenter.pdf"}

Result API Demo

You can use the request id 3d51225d80 to try the Result API. Optionally you can use true for PDF Required.




Landlord AML Check API

The Landlord AML Check API is used to request an Identity, Property Ownership, Selective Licensing and Anti Money Laundering (AML) check, a common need when adding a new landlord to an agency (UK bank check optional). The property ownership check includes properties located in England and Wales only.

This is a post based json rest api, for it to work you need to include your api key in your post request (you can apply for this here) as well as the parameters listed below.

  • "api_key"
  • "landlord_aml_id"
  • "pdf_report"
  • "first_name"
  • "last_name"
  • "country_of_residence"
  • "nationality"
  • "address1_line1"
  • "address1_postcode"
  • - then either the parameters listed below -
  • "dob"
  • "home_address_line1"
  • "home_address_postcode"
  • "account_number"
  • "sort_code"
  • - or the id_doc_url parameter below -
  • "id_doc_url"
  • - optional parameters listed below -
  • "business_country_of_registration"
  • "notes"
  • "address1_ltd_company_or_llp_name"
  • "address2_line1"
  • "address2_postcode"
  • "address2_ltd_company_or_llp_name"
  • "address3_line1"
  • "address3_postcode"
  • "address3_ltd_company_or_llp_name"
  • "address4_line1"
  • "address4_postcode"
  • "address4_ltd_company_or_llp_name"
  • "address5_line1"
  • "address5_postcode"
  • "address5_ltd_company_or_llp_name"
  • "client_name"
  • "client_type"
  • "client_email"
  • "client_phone"

Note: Up to 5 rental properties can be added for the Landlord AML Check, if more than 5 it will be handled offline.

The "landlord_aml_id" is a unique static identifier (set by you) for each user you wish to run a Landlord AML Check on (note this ID should not dynamically change as each user should only be set one landlord_aml_id).

If the request has been made on behalf of a client then "client_name", "client_email", "client_phone", "client_type" (for example: "landlord" or "agent") can be optionally provided.

Landlord AML Check API Method

The request type is POST

Landlord AML Check API Data Params

Landlord AML Check API Request Data Param Types
{
    api_key : [string],
    landlord_aml_id : [string],
    pdf_report : [string],
    first_name : [string],
    last_name : [string],
    dob : [string],
    home_address_line1 : [string],
    home_address_postcode : [string],
    account_number : [string],
    sort_code : [string],
    country_of_residence : [string],
    nationality : [string],
    business_country_of_registration : [string],
    notes : [string],
    address1_line1 : [string],
    address1_postcode : [string],
    address1_ltd_company_or_llp_name : [string],
    address2_line1 : [string],
    address2_postcode : [string],
    address2_ltd_company_or_llp_name : [string],
    address3_line1 : [string],
    address3_postcode : [string],
    address3_ltd_company_or_llp_name : [string],
    address4_line1 : [string],
    address4_postcode : [string],
    address4_ltd_company_or_llp_name : [string],
    address5_line1 : [string],
    address5_postcode : [string],
    address5_ltd_company_or_llp_name : [string],
    client_name : [string],
    client_type : [string],
    client_email : [string],
    client_phone : [string]
}

Note: dob format is DD/MM/YYYY

Landlord AML Check API Request Data Params Example
{
    "api_key":"longrandomstringforapikey123456",
    "landlord_aml_id":"yfew6iug2nvta",
    "pdf_report":"false",
    "first_name":"John",
    "last_name":"Doe",
    "id_doc_url":"https://www.exampleurl.com/imagehostlocation/imageid",
    "country_of_residence":"England",
    "nationality":"United Kingdom",
    "address1_line1":"10 Oxford Street",
    "address1_postcode":"W1D 1AN",
    "address2_line1":"50 Cannon Street",
    "address2_postcode":"EC4N 6JJ"
}
Landlord AML Check API Response Data Param Types
{
    landlord_aml_id : [string],
    owner_status : [string],
    aml_status : [string],
    uk_bank_status : [string]
}

Note: uk_bank_status will only be returned if the account_number, sort_code, home_address_line1 and home_address_postcode is provided in the request.

Landlord AML Check API Response Data Params Example
{
   "landlord_aml_id":"yfew6iug2nvta",
   "owner_status":"pending",
   "aml_status":"pending"
}

Landlord AML Check API Endpoint

https://www.rentprofile.co/v1/api/landlord_aml/check
Landlord AML Check API Request Example
$ curl -H "Content-Type: application/json" -X POST -d '{"landlord_aml_id":"yfew6iug2nvta","api_key":"replace_this_with_your_api_key","pdf_report":"false","first_name":"John","last_name":"Doe","id_doc_url":"https://www.exampleurl.com/imagehostlocation/imageid","country_of_residence":"England","nationality":"United Kingdom","address1_line1":"10 Oxford Street","address1_postcode":"W1D 1AN","address2_line1":"50 Cannon Street","address2_postcode":"EC4N 6JJ"}' https://www.rentprofile.co/v1/api/landlord_aml/check
Landlord aml Check API Response Example
{"landlord_aml_id":"738y4i9","owner_status":"pending","aml_status":"pending"}



Landlord AML Status API

The Landlord AML Status API is used to check the latest status/result of a Landlord AML check.

This is a post based json rest api, for it to work you need to include your api key in your post request (you can apply for this here) as well as the parameters listed below.

  • "api_key"
  • "landlord_aml_id"

The "landlord_aml_id" is the landlord_aml_id parameter passed through when using the Landlord AML Check. This is a unique static identifier (set by you) for each user you wish to run a Landlord AML Check on (note this ID should not dynamically change as each user should only be set one landlord_aml_id).

Landlord AML Status API Method

The request type is POST

Landlord AML Status API Data Params

Landlord AML Status API Request Data Param Types
{
    api_key : [string],
    landlord_aml_id : [string]
}
Landlord AML Status API Request Data Params Example
{
    "api_key":"longrandomstringforapikey123456",
    "landlord_aml_id":"yfew6iug2nvta"
}
Landlord AML Status API Response Data Param Types
{
    landlord_aml_id : [string],
    owner_status : [string],
    aml_status : [string],
    uk_bank_status : [string],
    pdf_report : [string],
    identity : [string],
    sanctions : [string],
    pep : [string],
    rca : [string],
    sip : [string],
    ool : [string],
    address_1_full : [string],
    address_1_ownership : [string],
    address_2_full : [string],
    address_2_ownership : [string],
    address_3_full : [string],
    address_3_ownership : [string],
    address_4_full : [string],
    address_4_ownership : [string]
    address_5_full : [string],
    address_5_ownership : [string]
}

pep - Politically Exposed Persons
rca - Relatives, Close Associates
sip - Special Interest Persons
ool - Other Official Lists

Note: uk_bank_status will only be returned if the account_number, sort_code, home_address_line1 and home_address_postcode is provided in the request.

Landlord AML Status API Response Data Params Example
{
   "landlord_aml_id":"yfew6iug2nvta",
   "owner_status":"pass",
   "aml_status":"pass",
   "identity":"pass",
   "sanctions":"pass",
   "pep":"pass",
   "rca":"pass",
   "sip":"pass",
   "ool":"pass",
   "address_1_full":"10 Oxford Street, Soho, London, W1D 1AN",
   "address_1_ownership":"true",
   "address_2_full":"50 Cannon Street, London, EC4N 6JJ",
   "address_2_ownership":"true"
}

Notes on responses:
owner_status responses can be "pending", "unclear document", "in progress", "pass" or "fail"
aml_status responses can be "pending", "unclear document", "in progress", "pass" or "fail"
if pdf_report is requested as "true" in the Landlord AML Check API the response can be "pending" or the url path to the pdf report
identity responses can be "unclear document", "pending", "pass" or "fail"
sanctions, pep, rca, sip and ool responses can be "pending", "not applicable", "pass" or "fail"
address_(number)_ownership responses can be "pending", "true" or "false"
404 Not Found if there is no matching request for the landlord_aml_id

Landlord AML Status API Endpoint

https://www.rentprofile.co/v1/api/landlord_aml/status
Landlord AML Status API Request Example
$ curl -H "Content-Type: application/json" -X POST -d '{"landlord_aml_id":"yfew6iug2nvta","api_key":"replace_this_with_your_api_key"}' https://www.rentprofile.co/v1/api/landlord_aml/status
Landlord AML Status API Response Example
{"landlord_aml_id":"yfew6iug2nvta","owner_status":"pass","aml_status":"pass","identity":"pass","sanctions":"pass","pep":"pass","rca":"pass","sip":"pass","ool":"pass","address_1_full":"10 Oxford Street, Soho, London, W1D 1AN","address_1_ownership":"true","address_2_full":"50 Cannon Street, London, EC4N 6JJ","address_2_ownership":"true"}