POST ShortApplication/CreditPull

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
sa_ApplicationID		integer	None.
TypeofPull		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "sa_ApplicationID": 1,
  "TypeofPull": 1
}

application/xml, text/xml

Sample:

<C21SoftPullInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <TypeofPull>1</TypeofPull>
  <sa_ApplicationID>1</sa_ApplicationID>
</C21SoftPullInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'C21SoftPullInput'.

Response Information

Resource Description

C21SoftPullOutput

Name	Type	Additional information
error	string	None.
report	ShortApp_CreditReportModel	None.
ReturnStatus	ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "error": "sample string 1",
  "report": {
    "RawXML": "sample string 1",
    "HumanReadable": "sample string 2",
    "FFF": "sample string 3",
    "Liabilities": [
      {
        "LiabilityTypeDD": 1,
        "Limit": 1.0,
        "Balance": 1.0,
        "Description": "sample string 2",
        "Payment": 1.0,
        "MaturityDate": "2025-12-15T22:56:04.084494-05:00"
      },
      {
        "LiabilityTypeDD": 1,
        "Limit": 1.0,
        "Balance": 1.0,
        "Description": "sample string 2",
        "Payment": 1.0,
        "MaturityDate": "2025-12-15T22:56:04.084494-05:00"
      }
    ],
    "CreditScore": 1,
    "Hit": {
      "HitCode": 1,
      "HitDescription": "sample string 1",
      "NoHit": true
    }
  },
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<C21SoftPullOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <error>sample string 1</error>
  <report>
    <CreditScore>1</CreditScore>
    <FFF>sample string 3</FFF>
    <Hit>
      <HitCode>1</HitCode>
      <HitDescription>sample string 1</HitDescription>
      <NoHit>true</NoHit>
    </Hit>
    <HumanReadable>sample string 2</HumanReadable>
    <Liabilities>
      <ShortApp_LiabilityModel>
        <Balance>1</Balance>
        <Description>sample string 2</Description>
        <LiabilityTypeDD>1</LiabilityTypeDD>
        <Limit>1</Limit>
        <MaturityDate>2025-12-15T22:56:04.084494-05:00</MaturityDate>
        <Payment>1</Payment>
      </ShortApp_LiabilityModel>
      <ShortApp_LiabilityModel>
        <Balance>1</Balance>
        <Description>sample string 2</Description>
        <LiabilityTypeDD>1</LiabilityTypeDD>
        <Limit>1</Limit>
        <MaturityDate>2025-12-15T22:56:04.084494-05:00</MaturityDate>
        <Payment>1</Payment>
      </ShortApp_LiabilityModel>
    </Liabilities>
    <RawXML>sample string 1</RawXML>
  </report>
</C21SoftPullOutput>