POST api/EoA

Create a new Evidence of Criteria document

Request Information

URI Parameters

None.

Body Parameters

EoARequest
NameDescriptionTypeAdditional information
LicenseKey

string

None.

CompanyId

string

None.

SiteId

string

None.

Summary

boolean

None.

AdvisorName

string

None.

AdditionalInformation

string

None.

Applicants

Collection of EoAApplicant

None.

LoanDetails

EoALoanDetails

None.

ResultGrids

Collection of EoAResultsGrid

None.

HeaderImageBase64

string

None.

HeaderImageType

ImageType

None.

PropertyDetails

EoAPropertyDetails

None.

Request Formats

application/json, text/json

Sample:
{
  "LicenseKey": "sample string 1",
  "CompanyId": "sample string 2",
  "SiteId": "sample string 3",
  "Summary": true,
  "AdvisorName": "sample string 5",
  "AdditionalInformation": "sample string 6",
  "Applicants": [
    {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "DateOfBirth": "sample string 5",
      "Type": "sample string 6",
      "EmploymentStatus": "sample string 7",
      "Maritaltatus": "sample string 8",
      "Income": 9,
      "SelfEmployedProfitBeforeTax": 10,
      "TotalNumberOfDependants": 11,
      "NetProfitsLastYear": 12,
      "NetProfitsTwoYearsAgo": 13,
      "NetProfitsThreeYearsAgo": 14,
      "RetainedProfitsLastYear": 15,
      "RetainedProfitsTwoYearsAgo": 16,
      "RetainedProfitsThreeYearsAgo": 17,
      "DividendsLastYear": 18,
      "DividendsTwoYearsAgo": 19,
      "DividendsThreeYearsAgo": 20,
      "SalaryIncomeLastYear": 21,
      "SalaryIncomeTwoYearsAgo": 22,
      "SalaryIncomeThreeYearsAgo": 23,
      "Employment": {
        "EmploymentStatus": "sample string 1",
        "BasicAnnualIncome": 2,
        "ProfitBeforeTax": 1
      },
      "Outgoings": {
        "Commitments": 1.0,
        "Household": 1,
        "LivingCosts": 1,
        "Lifestyle": 1,
        "Transport": 1,
        "ChildrenCosts": 1
      }
    },
    {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "DateOfBirth": "sample string 5",
      "Type": "sample string 6",
      "EmploymentStatus": "sample string 7",
      "Maritaltatus": "sample string 8",
      "Income": 9,
      "SelfEmployedProfitBeforeTax": 10,
      "TotalNumberOfDependants": 11,
      "NetProfitsLastYear": 12,
      "NetProfitsTwoYearsAgo": 13,
      "NetProfitsThreeYearsAgo": 14,
      "RetainedProfitsLastYear": 15,
      "RetainedProfitsTwoYearsAgo": 16,
      "RetainedProfitsThreeYearsAgo": 17,
      "DividendsLastYear": 18,
      "DividendsTwoYearsAgo": 19,
      "DividendsThreeYearsAgo": 20,
      "SalaryIncomeLastYear": 21,
      "SalaryIncomeTwoYearsAgo": 22,
      "SalaryIncomeThreeYearsAgo": 23,
      "Employment": {
        "EmploymentStatus": "sample string 1",
        "BasicAnnualIncome": 2,
        "ProfitBeforeTax": 1
      },
      "Outgoings": {
        "Commitments": 1.0,
        "Household": 1,
        "LivingCosts": 1,
        "Lifestyle": 1,
        "Transport": 1,
        "ChildrenCosts": 1
      }
    }
  ],
  "LoanDetails": {
    "LoanPurpose": "sample string 1",
    "ReasonForRemortgage": "sample string 2",
    "PropertyValue": 3.0,
    "LoanAmount": 4.0,
    "LoanToValue": 5.0,
    "Term": 6,
    "TermUnit": 0,
    "PaymentMethod": 0,
    "PaymentMethodDescription": "sample string 7",
    "MortgageType": 0
  },
  "ResultGrids": [
    {
      "GridTitle": "sample string 1",
      "GridDescription": "sample string 2",
      "GridSummary": "sample string 3",
      "Filters": {
        "Status": "sample string 1",
        "Term": "sample string 2"
      },
      "Affordability": [
        {
          "AfforabilityId": 1,
          "AfforabilityLikelihood": "sample string 2",
          "LenderName": "sample string 3",
          "MaxBorrowing": "sample string 4",
          "AffordabilityScoreGridResult": 1,
          "ScreenshotUrl": "sample string 5",
          "Notes": "sample string 6"
        },
        {
          "AfforabilityId": 1,
          "AfforabilityLikelihood": "sample string 2",
          "LenderName": "sample string 3",
          "MaxBorrowing": "sample string 4",
          "AffordabilityScoreGridResult": 1,
          "ScreenshotUrl": "sample string 5",
          "Notes": "sample string 6"
        }
      ],
      "NumHeaders": 4,
      "AffordabilityType": 0
    },
    {
      "GridTitle": "sample string 1",
      "GridDescription": "sample string 2",
      "GridSummary": "sample string 3",
      "Filters": {
        "Status": "sample string 1",
        "Term": "sample string 2"
      },
      "Affordability": [
        {
          "AfforabilityId": 1,
          "AfforabilityLikelihood": "sample string 2",
          "LenderName": "sample string 3",
          "MaxBorrowing": "sample string 4",
          "AffordabilityScoreGridResult": 1,
          "ScreenshotUrl": "sample string 5",
          "Notes": "sample string 6"
        },
        {
          "AfforabilityId": 1,
          "AfforabilityLikelihood": "sample string 2",
          "LenderName": "sample string 3",
          "MaxBorrowing": "sample string 4",
          "AffordabilityScoreGridResult": 1,
          "ScreenshotUrl": "sample string 5",
          "Notes": "sample string 6"
        }
      ],
      "NumHeaders": 4,
      "AffordabilityType": 0
    }
  ],
  "HeaderImageBase64": "sample string 7",
  "HeaderImageType": 0,
  "PropertyDetails": {
    "Location": "sample string 1",
    "Type": "sample string 2",
    "Style": "sample string 3",
    "Tenure": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<EoARequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common">
  <AdditionalInformation>sample string 6</AdditionalInformation>
  <AdvisorName>sample string 5</AdvisorName>
  <Applicants>
    <EoAApplicant>
      <DateOfBirth>sample string 5</DateOfBirth>
      <DividendsLastYear>18</DividendsLastYear>
      <DividendsThreeYearsAgo>20</DividendsThreeYearsAgo>
      <DividendsTwoYearsAgo>19</DividendsTwoYearsAgo>
      <Employment>
        <BasicAnnualIncome>2</BasicAnnualIncome>
        <EmploymentStatus>sample string 1</EmploymentStatus>
        <ProfitBeforeTax>1</ProfitBeforeTax>
      </Employment>
      <EmploymentStatus>sample string 7</EmploymentStatus>
      <FirstName>sample string 2</FirstName>
      <Income>9</Income>
      <LastName>sample string 4</LastName>
      <Maritaltatus>sample string 8</Maritaltatus>
      <MiddleName>sample string 3</MiddleName>
      <NetProfitsLastYear>12</NetProfitsLastYear>
      <NetProfitsThreeYearsAgo>14</NetProfitsThreeYearsAgo>
      <NetProfitsTwoYearsAgo>13</NetProfitsTwoYearsAgo>
      <Outgoings>
        <ChildrenCosts>1</ChildrenCosts>
        <Commitments>1</Commitments>
        <Household>1</Household>
        <Lifestyle>1</Lifestyle>
        <LivingCosts>1</LivingCosts>
        <Transport>1</Transport>
      </Outgoings>
      <RetainedProfitsLastYear>15</RetainedProfitsLastYear>
      <RetainedProfitsThreeYearsAgo>17</RetainedProfitsThreeYearsAgo>
      <RetainedProfitsTwoYearsAgo>16</RetainedProfitsTwoYearsAgo>
      <SalaryIncomeLastYear>21</SalaryIncomeLastYear>
      <SalaryIncomeThreeYearsAgo>23</SalaryIncomeThreeYearsAgo>
      <SalaryIncomeTwoYearsAgo>22</SalaryIncomeTwoYearsAgo>
      <SelfEmployedProfitBeforeTax>10</SelfEmployedProfitBeforeTax>
      <Title>sample string 1</Title>
      <TotalNumberOfDependants>11</TotalNumberOfDependants>
      <Type>sample string 6</Type>
    </EoAApplicant>
    <EoAApplicant>
      <DateOfBirth>sample string 5</DateOfBirth>
      <DividendsLastYear>18</DividendsLastYear>
      <DividendsThreeYearsAgo>20</DividendsThreeYearsAgo>
      <DividendsTwoYearsAgo>19</DividendsTwoYearsAgo>
      <Employment>
        <BasicAnnualIncome>2</BasicAnnualIncome>
        <EmploymentStatus>sample string 1</EmploymentStatus>
        <ProfitBeforeTax>1</ProfitBeforeTax>
      </Employment>
      <EmploymentStatus>sample string 7</EmploymentStatus>
      <FirstName>sample string 2</FirstName>
      <Income>9</Income>
      <LastName>sample string 4</LastName>
      <Maritaltatus>sample string 8</Maritaltatus>
      <MiddleName>sample string 3</MiddleName>
      <NetProfitsLastYear>12</NetProfitsLastYear>
      <NetProfitsThreeYearsAgo>14</NetProfitsThreeYearsAgo>
      <NetProfitsTwoYearsAgo>13</NetProfitsTwoYearsAgo>
      <Outgoings>
        <ChildrenCosts>1</ChildrenCosts>
        <Commitments>1</Commitments>
        <Household>1</Household>
        <Lifestyle>1</Lifestyle>
        <LivingCosts>1</LivingCosts>
        <Transport>1</Transport>
      </Outgoings>
      <RetainedProfitsLastYear>15</RetainedProfitsLastYear>
      <RetainedProfitsThreeYearsAgo>17</RetainedProfitsThreeYearsAgo>
      <RetainedProfitsTwoYearsAgo>16</RetainedProfitsTwoYearsAgo>
      <SalaryIncomeLastYear>21</SalaryIncomeLastYear>
      <SalaryIncomeThreeYearsAgo>23</SalaryIncomeThreeYearsAgo>
      <SalaryIncomeTwoYearsAgo>22</SalaryIncomeTwoYearsAgo>
      <SelfEmployedProfitBeforeTax>10</SelfEmployedProfitBeforeTax>
      <Title>sample string 1</Title>
      <TotalNumberOfDependants>11</TotalNumberOfDependants>
      <Type>sample string 6</Type>
    </EoAApplicant>
  </Applicants>
  <CompanyId>sample string 2</CompanyId>
  <HeaderImageBase64>sample string 7</HeaderImageBase64>
  <HeaderImageType>Jpeg</HeaderImageType>
  <LicenseKey>sample string 1</LicenseKey>
  <LoanDetails>
    <LoanAmount>4</LoanAmount>
    <LoanPurpose>sample string 1</LoanPurpose>
    <LoanToValue>5</LoanToValue>
    <MortgageType>Standard</MortgageType>
    <PaymentMethod>Repayment</PaymentMethod>
    <PaymentMethodDescription>sample string 7</PaymentMethodDescription>
    <PropertyValue>3</PropertyValue>
    <ReasonForRemortgage>sample string 2</ReasonForRemortgage>
    <Term>6</Term>
    <TermUnit>Years</TermUnit>
  </LoanDetails>
  <PropertyDetails>
    <Location>sample string 1</Location>
    <Style>sample string 3</Style>
    <Tenure>sample string 4</Tenure>
    <Type>sample string 2</Type>
  </PropertyDetails>
  <ResultGrids>
    <EoAResultsGrid>
      <Affordability>
        <EoAResults>
          <AfforabilityId>1</AfforabilityId>
          <AfforabilityLikelihood>sample string 2</AfforabilityLikelihood>
          <AffordabilityScoreGridResult>AllAccept</AffordabilityScoreGridResult>
          <LenderName>sample string 3</LenderName>
          <MaxBorrowing>sample string 4</MaxBorrowing>
          <Notes>sample string 6</Notes>
          <ScreenshotUrl>sample string 5</ScreenshotUrl>
        </EoAResults>
        <EoAResults>
          <AfforabilityId>1</AfforabilityId>
          <AfforabilityLikelihood>sample string 2</AfforabilityLikelihood>
          <AffordabilityScoreGridResult>AllAccept</AffordabilityScoreGridResult>
          <LenderName>sample string 3</LenderName>
          <MaxBorrowing>sample string 4</MaxBorrowing>
          <Notes>sample string 6</Notes>
          <ScreenshotUrl>sample string 5</ScreenshotUrl>
        </EoAResults>
      </Affordability>
      <AffordabilityType>Experian</AffordabilityType>
      <Filters>
        <Status>sample string 1</Status>
        <Term>sample string 2</Term>
      </Filters>
      <GridDescription>sample string 2</GridDescription>
      <GridSummary>sample string 3</GridSummary>
      <GridTitle>sample string 1</GridTitle>
      <NumHeaders>4</NumHeaders>
    </EoAResultsGrid>
    <EoAResultsGrid>
      <Affordability>
        <EoAResults>
          <AfforabilityId>1</AfforabilityId>
          <AfforabilityLikelihood>sample string 2</AfforabilityLikelihood>
          <AffordabilityScoreGridResult>AllAccept</AffordabilityScoreGridResult>
          <LenderName>sample string 3</LenderName>
          <MaxBorrowing>sample string 4</MaxBorrowing>
          <Notes>sample string 6</Notes>
          <ScreenshotUrl>sample string 5</ScreenshotUrl>
        </EoAResults>
        <EoAResults>
          <AfforabilityId>1</AfforabilityId>
          <AfforabilityLikelihood>sample string 2</AfforabilityLikelihood>
          <AffordabilityScoreGridResult>AllAccept</AffordabilityScoreGridResult>
          <LenderName>sample string 3</LenderName>
          <MaxBorrowing>sample string 4</MaxBorrowing>
          <Notes>sample string 6</Notes>
          <ScreenshotUrl>sample string 5</ScreenshotUrl>
        </EoAResults>
      </Affordability>
      <AffordabilityType>Experian</AffordabilityType>
      <Filters>
        <Status>sample string 1</Status>
        <Term>sample string 2</Term>
      </Filters>
      <GridDescription>sample string 2</GridDescription>
      <GridSummary>sample string 3</GridSummary>
      <GridTitle>sample string 1</GridTitle>
      <NumHeaders>4</NumHeaders>
    </EoAResultsGrid>
  </ResultGrids>
  <SiteId>sample string 3</SiteId>
  <Summary>true</Summary>
</EoARequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An EoA document id

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.