POST api/Retailer/EligibilityCheck

Create a new eligibility check

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FinanceDetails	FinanceDetailsRequestModel	None.
CustomerDetails	CustomerDetailsRequestModel	None.
EmploymentDetails	EligibilityCheckEmploymentDetailsRequestModel	None.

Request Formats

application/json, text/json

Sample:

{
  "FinanceDetails": {
    "RateCardProductId": "98b92b1c-51e5-43e7-bda0-0cf915a8a77a",
    "Price": 1.0,
    "Deposit": 1.0
  },
  "CustomerDetails": {
    "CustomerEmail": "sample string 1",
    "TitleId": "3823623b-ae21-4fcf-b378-7ed50e16e2ff",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "DateOfBirth": "2025-11-05T17:12:32.545925+00:00",
    "ResidentialStatusId": "77728c5d-c7d2-4ff7-b81a-2ea19d95272e",
    "MonthlyRentAmount": 1.0,
    "NumberOfDependants": 1,
    "CurrentAddress": {
      "PostCode": "sample string 1",
      "City": "sample string 2",
      "Flat": "sample string 3",
      "HouseNumber": "sample string 4",
      "HouseName": "sample string 5",
      "Street": "sample string 6"
    }
  },
  "EmploymentDetails": {
    "EmploymentStatusId": "6bfc608c-fb8c-484a-828d-82d60ec143fb",
    "GrossAnnualIncome": 1.0
  }
}

text/html

Sample:

{"FinanceDetails":{"RateCardProductId":"98b92b1c-51e5-43e7-bda0-0cf915a8a77a","Price":1.0,"Deposit":1.0},"CustomerDetails":{"CustomerEmail":"sample string 1","TitleId":"3823623b-ae21-4fcf-b378-7ed50e16e2ff","FirstName":"sample string 2","LastName":"sample string 3","DateOfBirth":"2025-11-05T17:12:32.545925+00:00","ResidentialStatusId":"77728c5d-c7d2-4ff7-b81a-2ea19d95272e","MonthlyRentAmount":1.0,"NumberOfDependants":1,"CurrentAddress":{"PostCode":"sample string 1","City":"sample string 2","Flat":"sample string 3","HouseNumber":"sample string 4","HouseName":"sample string 5","Street":"sample string 6"}},"EmploymentDetails":{"EmploymentStatusId":"6bfc608c-fb8c-484a-828d-82d60ec143fb","GrossAnnualIncome":1.0}}

application/xml, text/xml

Sample:

<EligibilityCheckRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIRequests.EligibilityCheckRequestModels">
  <CustomerDetails>
    <CurrentAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
      <d3p1:City>sample string 2</d3p1:City>
      <d3p1:Flat>sample string 3</d3p1:Flat>
      <d3p1:HouseName>sample string 5</d3p1:HouseName>
      <d3p1:HouseNumber>sample string 4</d3p1:HouseNumber>
      <d3p1:PostCode>sample string 1</d3p1:PostCode>
      <d3p1:Street>sample string 6</d3p1:Street>
    </CurrentAddress>
    <CustomerEmail>sample string 1</CustomerEmail>
    <DateOfBirth>2025-11-05T17:12:32.545925+00:00</DateOfBirth>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <MonthlyRentAmount>1</MonthlyRentAmount>
    <NumberOfDependants>1</NumberOfDependants>
    <ResidentialStatusId>77728c5d-c7d2-4ff7-b81a-2ea19d95272e</ResidentialStatusId>
    <TitleId>3823623b-ae21-4fcf-b378-7ed50e16e2ff</TitleId>
  </CustomerDetails>
  <EmploymentDetails>
    <EmploymentStatusId>6bfc608c-fb8c-484a-828d-82d60ec143fb</EmploymentStatusId>
    <GrossAnnualIncome>1</GrossAnnualIncome>
  </EmploymentDetails>
  <FinanceDetails>
    <Deposit>1</Deposit>
    <Price>1</Price>
    <RateCardProductId>98b92b1c-51e5-43e7-bda0-0cf915a8a77a</RateCardProductId>
  </FinanceDetails>
</EligibilityCheckRequestModel>

Response Information

Resource Description

Returns the eligibility check details.

EligibilityCheckResponseModel

Name	Type	Additional information
EligibilityCheckId	globally unique identifier	None.
Status	string	None.
ActiveUntil	date	None.
UpperLoanValue	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "EligibilityCheckId": "79f4be54-701f-4715-b587-17fc524f9cea",
  "Status": "sample string 2",
  "ActiveUntil": "2025-11-05T17:12:32.5616167+00:00",
  "UpperLoanValue": 1.0
}

text/html

Sample:

{"EligibilityCheckId":"79f4be54-701f-4715-b587-17fc524f9cea","Status":"sample string 2","ActiveUntil":"2025-11-05T17:12:32.5616167+00:00","UpperLoanValue":1.0}

application/xml, text/xml

Sample:

<EligibilityCheckResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.EligibilityCheckResponseModels">
  <ActiveUntil>2025-11-05T17:12:32.5616167+00:00</ActiveUntil>
  <EligibilityCheckId>79f4be54-701f-4715-b587-17fc524f9cea</EligibilityCheckId>
  <Status>sample string 2</Status>
  <UpperLoanValue>1</UpperLoanValue>
</EligibilityCheckResponseModel>