POST api/Equifax/EquifaxCreditCheck

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
serviceStatus	ServiceStatus	None.
Slug	string	None.
TopUp	boolean	None.
isSubsequentRequest	boolean	None.
clientRef	string	None.
CustomerID	integer	None.
primary	PersonModel	None.
isJointSearch	boolean	None.
secondary	PersonModel	None.
multipleAddressRequest	boolean	None.
outputAddressRequest	boolean	None.
outputAddressLinked	boolean	None.
treasurySanctionsCheckRequest	boolean	None.
seniorPoliticalFiguresSanctionsCheckRequest	boolean	None.
haloDeceasedCheckRequest	boolean	None.
homeTelephoneCheckRequest	boolean	None.
bankCheckRequest	boolean	None.
idPlusRequest	boolean	None.
scoreRequests	boolean	None.
scoreLabel	Collection of string	None.
characteristicRequests	boolean	None.
characteristicsLinked	boolean	None.
enhancedWatchlistCheckSummaryRequest	boolean	None.
enhancedWatchlistCheckRequest	boolean	None.
employmentRequest	boolean	None.
insightRequest	boolean	None.
insightLinked	boolean	None.
electoralRollRequest	boolean	None.
electoralRollLinked	boolean	None.
courtAndInsolvencyInformationRequest	boolean	None.
courtAndInsolvencyInformationLinked	boolean	None.
telephoneNumberRequest	boolean	None.
aliasRequest	boolean	None.
associateRequest	boolean	None.
searchesRequest	boolean	None.
noticeOfCorrection	boolean	None.
matchCriteria	EquifaxMatchCriteria	None.
clientId	string	None.
clientSecret	string	None.
LoanType	string	None.

Request Formats

application/json, text/json

Sample:

{
  "serviceStatus": 0,
  "Slug": "sample string 1",
  "TopUp": true,
  "isSubsequentRequest": true,
  "clientRef": "sample string 4",
  "CustomerID": 5,
  "primary": {
    "PersonId": 1,
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "MiddleName": "sample string 4",
    "Title": "sample string 5",
    "PreviousForename": "sample string 6",
    "PreviousSurname": "sample string 7",
    "PreviousTitle": "sample string 8",
    "PreviousMiddleName": "sample string 9",
    "CurrentAddress": {
      "Flat": true,
      "HouseNumber": "sample string 2",
      "HouseName": "sample string 3",
      "POBox": "sample string 4",
      "Postcode": "sample string 5",
      "PostTown": "sample string 6",
      "StreetOne": "sample string 7",
      "StreetTwo": "sample string 8",
      "AddressID": "sample string 9",
      "Matched": true,
      "ResidenceType": 0
    },
    "PreviousAddress": {
      "Flat": true,
      "HouseNumber": "sample string 2",
      "HouseName": "sample string 3",
      "POBox": "sample string 4",
      "Postcode": "sample string 5",
      "PostTown": "sample string 6",
      "StreetOne": "sample string 7",
      "StreetTwo": "sample string 8",
      "AddressID": "sample string 9",
      "Matched": true,
      "ResidenceType": 0
    },
    "DateOfBirth": "2026-02-14T12:38:18.9666242+00:00",
    "TelephonePrefix": "sample string 11",
    "TelephoneNumber": "sample string 12",
    "TelephoneType": 0,
    "TelephoneUsageType": 0,
    "Nationality": "sample string 13",
    "CountryOfResidence": "sample string 14",
    "AnnualSalary": 15,
    "BankAccount": {
      "AccountNumber": "sample string 1",
      "SortCode": "sample string 2"
    }
  },
  "isJointSearch": true,
  "secondary": {
    "PersonId": 1,
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "MiddleName": "sample string 4",
    "Title": "sample string 5",
    "PreviousForename": "sample string 6",
    "PreviousSurname": "sample string 7",
    "PreviousTitle": "sample string 8",
    "PreviousMiddleName": "sample string 9",
    "CurrentAddress": {
      "Flat": true,
      "HouseNumber": "sample string 2",
      "HouseName": "sample string 3",
      "POBox": "sample string 4",
      "Postcode": "sample string 5",
      "PostTown": "sample string 6",
      "StreetOne": "sample string 7",
      "StreetTwo": "sample string 8",
      "AddressID": "sample string 9",
      "Matched": true,
      "ResidenceType": 0
    },
    "PreviousAddress": {
      "Flat": true,
      "HouseNumber": "sample string 2",
      "HouseName": "sample string 3",
      "POBox": "sample string 4",
      "Postcode": "sample string 5",
      "PostTown": "sample string 6",
      "StreetOne": "sample string 7",
      "StreetTwo": "sample string 8",
      "AddressID": "sample string 9",
      "Matched": true,
      "ResidenceType": 0
    },
    "DateOfBirth": "2026-02-14T12:38:18.9666242+00:00",
    "TelephonePrefix": "sample string 11",
    "TelephoneNumber": "sample string 12",
    "TelephoneType": 0,
    "TelephoneUsageType": 0,
    "Nationality": "sample string 13",
    "CountryOfResidence": "sample string 14",
    "AnnualSalary": 15,
    "BankAccount": {
      "AccountNumber": "sample string 1",
      "SortCode": "sample string 2"
    }
  },
  "multipleAddressRequest": true,
  "outputAddressRequest": true,
  "outputAddressLinked": true,
  "treasurySanctionsCheckRequest": true,
  "seniorPoliticalFiguresSanctionsCheckRequest": true,
  "haloDeceasedCheckRequest": true,
  "homeTelephoneCheckRequest": true,
  "bankCheckRequest": true,
  "idPlusRequest": true,
  "scoreRequests": true,
  "scoreLabel": [
    "sample string 1",
    "sample string 2"
  ],
  "characteristicRequests": true,
  "characteristicsLinked": true,
  "enhancedWatchlistCheckSummaryRequest": true,
  "enhancedWatchlistCheckRequest": true,
  "employmentRequest": true,
  "insightRequest": true,
  "insightLinked": true,
  "electoralRollRequest": true,
  "electoralRollLinked": true,
  "courtAndInsolvencyInformationRequest": true,
  "courtAndInsolvencyInformationLinked": true,
  "telephoneNumberRequest": true,
  "aliasRequest": true,
  "associateRequest": true,
  "searchesRequest": true,
  "noticeOfCorrection": true,
  "matchCriteria": 0,
  "clientId": "sample string 33",
  "clientSecret": "sample string 34",
  "LoanType": "sample string 35"
}

application/xml, text/xml

Sample:

<EquifaxRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Equifax.Model">
  <CustomerID>5</CustomerID>
  <LoanType>sample string 35</LoanType>
  <Slug>sample string 1</Slug>
  <TopUp>true</TopUp>
  <aliasRequest>true</aliasRequest>
  <associateRequest>true</associateRequest>
  <bankCheckRequest>true</bankCheckRequest>
  <characteristicRequests>true</characteristicRequests>
  <characteristicsLinked>true</characteristicsLinked>
  <clientId>sample string 33</clientId>
  <clientRef>sample string 4</clientRef>
  <clientSecret>sample string 34</clientSecret>
  <courtAndInsolvencyInformationLinked>true</courtAndInsolvencyInformationLinked>
  <courtAndInsolvencyInformationRequest>true</courtAndInsolvencyInformationRequest>
  <electoralRollLinked>true</electoralRollLinked>
  <electoralRollRequest>true</electoralRollRequest>
  <employmentRequest>true</employmentRequest>
  <enhancedWatchlistCheckRequest>true</enhancedWatchlistCheckRequest>
  <enhancedWatchlistCheckSummaryRequest>true</enhancedWatchlistCheckSummaryRequest>
  <haloDeceasedCheckRequest>true</haloDeceasedCheckRequest>
  <homeTelephoneCheckRequest>true</homeTelephoneCheckRequest>
  <idPlusRequest>true</idPlusRequest>
  <insightLinked>true</insightLinked>
  <insightRequest>true</insightRequest>
  <isJointSearch>true</isJointSearch>
  <isSubsequentRequest>true</isSubsequentRequest>
  <matchCriteria>None</matchCriteria>
  <multipleAddressRequest>true</multipleAddressRequest>
  <noticeOfCorrection>true</noticeOfCorrection>
  <outputAddressLinked>true</outputAddressLinked>
  <outputAddressRequest>true</outputAddressRequest>
  <primary>
    <AnnualSalary>15</AnnualSalary>
    <BankAccount>
      <AccountNumber>sample string 1</AccountNumber>
      <SortCode>sample string 2</SortCode>
    </BankAccount>
    <CountryOfResidence>sample string 14</CountryOfResidence>
    <CurrentAddress>
      <AddressID>sample string 9</AddressID>
      <Flat>true</Flat>
      <HouseName>sample string 3</HouseName>
      <HouseNumber>sample string 2</HouseNumber>
      <Matched>true</Matched>
      <POBox>sample string 4</POBox>
      <PostTown>sample string 6</PostTown>
      <Postcode>sample string 5</Postcode>
      <ResidenceType>detached</ResidenceType>
      <StreetOne>sample string 7</StreetOne>
      <StreetTwo>sample string 8</StreetTwo>
    </CurrentAddress>
    <DateOfBirth>2026-02-14T12:38:18.9666242+00:00</DateOfBirth>
    <Forename>sample string 2</Forename>
    <MiddleName>sample string 4</MiddleName>
    <Nationality>sample string 13</Nationality>
    <PersonId>1</PersonId>
    <PreviousAddress>
      <AddressID>sample string 9</AddressID>
      <Flat>true</Flat>
      <HouseName>sample string 3</HouseName>
      <HouseNumber>sample string 2</HouseNumber>
      <Matched>true</Matched>
      <POBox>sample string 4</POBox>
      <PostTown>sample string 6</PostTown>
      <Postcode>sample string 5</Postcode>
      <ResidenceType>detached</ResidenceType>
      <StreetOne>sample string 7</StreetOne>
      <StreetTwo>sample string 8</StreetTwo>
    </PreviousAddress>
    <PreviousForename>sample string 6</PreviousForename>
    <PreviousMiddleName>sample string 9</PreviousMiddleName>
    <PreviousSurname>sample string 7</PreviousSurname>
    <PreviousTitle>sample string 8</PreviousTitle>
    <Surname>sample string 3</Surname>
    <TelephoneNumber>sample string 12</TelephoneNumber>
    <TelephonePrefix>sample string 11</TelephonePrefix>
    <TelephoneType>fixed</TelephoneType>
    <TelephoneUsageType>personal</TelephoneUsageType>
    <Title>sample string 5</Title>
  </primary>
  <scoreLabel xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </scoreLabel>
  <scoreRequests>true</scoreRequests>
  <searchesRequest>true</searchesRequest>
  <secondary>
    <AnnualSalary>15</AnnualSalary>
    <BankAccount>
      <AccountNumber>sample string 1</AccountNumber>
      <SortCode>sample string 2</SortCode>
    </BankAccount>
    <CountryOfResidence>sample string 14</CountryOfResidence>
    <CurrentAddress>
      <AddressID>sample string 9</AddressID>
      <Flat>true</Flat>
      <HouseName>sample string 3</HouseName>
      <HouseNumber>sample string 2</HouseNumber>
      <Matched>true</Matched>
      <POBox>sample string 4</POBox>
      <PostTown>sample string 6</PostTown>
      <Postcode>sample string 5</Postcode>
      <ResidenceType>detached</ResidenceType>
      <StreetOne>sample string 7</StreetOne>
      <StreetTwo>sample string 8</StreetTwo>
    </CurrentAddress>
    <DateOfBirth>2026-02-14T12:38:18.9666242+00:00</DateOfBirth>
    <Forename>sample string 2</Forename>
    <MiddleName>sample string 4</MiddleName>
    <Nationality>sample string 13</Nationality>
    <PersonId>1</PersonId>
    <PreviousAddress>
      <AddressID>sample string 9</AddressID>
      <Flat>true</Flat>
      <HouseName>sample string 3</HouseName>
      <HouseNumber>sample string 2</HouseNumber>
      <Matched>true</Matched>
      <POBox>sample string 4</POBox>
      <PostTown>sample string 6</PostTown>
      <Postcode>sample string 5</Postcode>
      <ResidenceType>detached</ResidenceType>
      <StreetOne>sample string 7</StreetOne>
      <StreetTwo>sample string 8</StreetTwo>
    </PreviousAddress>
    <PreviousForename>sample string 6</PreviousForename>
    <PreviousMiddleName>sample string 9</PreviousMiddleName>
    <PreviousSurname>sample string 7</PreviousSurname>
    <PreviousTitle>sample string 8</PreviousTitle>
    <Surname>sample string 3</Surname>
    <TelephoneNumber>sample string 12</TelephoneNumber>
    <TelephonePrefix>sample string 11</TelephonePrefix>
    <TelephoneType>fixed</TelephoneType>
    <TelephoneUsageType>personal</TelephoneUsageType>
    <Title>sample string 5</Title>
  </secondary>
  <seniorPoliticalFiguresSanctionsCheckRequest>true</seniorPoliticalFiguresSanctionsCheckRequest>
  <serviceStatus>LIVE</serviceStatus>
  <telephoneNumberRequest>true</telephoneNumberRequest>
  <treasurySanctionsCheckRequest>true</treasurySanctionsCheckRequest>
</EquifaxRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.