POST ShortApplication/LoadKBAQuestinos

Request Information

URI Parameters

None.

Body Parameters

KBALoadQuestionsInput
NameDescriptionTypeAdditional information
Applicant

Applicant

None.

Sa_ApplicationID

integer

None.

languageID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Applicant": {
    "ApplicantID": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "DateOfBirth": "sample string 4",
    "CreditScore": {
      "label": "sample string 1",
      "value": 2
    },
    "EmailAddress": "sample string 5",
    "Phone": "sample string 6",
    "Address": {
      "AddressID": 1,
      "CountryTypeDD": 1,
      "ProvinceDD": 1,
      "StreetNumber": "sample string 2",
      "PostalFsa": "sample string 3",
      "PostalLdu": "sample string 4",
      "City": "sample string 5",
      "StreetName": "sample string 6",
      "StreetTypeDD": 1,
      "StreetDirectionDD": 1,
      "Unit": "sample string 7",
      "Text": "sample string 8",
      "shortFormatAddress": "sample string 9"
    }
  },
  "Sa_ApplicationID": 1,
  "languageID": "sample string 2"
}

application/xml, text/xml

Sample:
<KBALoadQuestionsInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Equifax.KBA">
  <Applicant xmlns:d2p1="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.ShortAppication">
    <d2p1:Address>
      <d2p1:AddressID>1</d2p1:AddressID>
      <d2p1:City>sample string 5</d2p1:City>
      <d2p1:CountryTypeDD>1</d2p1:CountryTypeDD>
      <d2p1:PostalFsa>sample string 3</d2p1:PostalFsa>
      <d2p1:PostalLdu>sample string 4</d2p1:PostalLdu>
      <d2p1:ProvinceDD>1</d2p1:ProvinceDD>
      <d2p1:StreetDirectionDD>1</d2p1:StreetDirectionDD>
      <d2p1:StreetName>sample string 6</d2p1:StreetName>
      <d2p1:StreetNumber>sample string 2</d2p1:StreetNumber>
      <d2p1:StreetTypeDD>1</d2p1:StreetTypeDD>
      <d2p1:Text>sample string 8</d2p1:Text>
      <d2p1:Unit>sample string 7</d2p1:Unit>
      <d2p1:shortFormatAddress>sample string 9</d2p1:shortFormatAddress>
    </d2p1:Address>
    <d2p1:ApplicantID>1</d2p1:ApplicantID>
    <d2p1:CreditScore>
      <d2p1:label>sample string 1</d2p1:label>
      <d2p1:value>2</d2p1:value>
    </d2p1:CreditScore>
    <d2p1:DateOfBirth>sample string 4</d2p1:DateOfBirth>
    <d2p1:EmailAddress>sample string 5</d2p1:EmailAddress>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:LastName>sample string 3</d2p1:LastName>
    <d2p1:Phone>sample string 6</d2p1:Phone>
  </Applicant>
  <Sa_ApplicationID>1</Sa_ApplicationID>
  <languageID>sample string 2</languageID>
</KBALoadQuestionsInput>

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 'KBALoadQuestionsInput'.

Response Information

Resource Description

KBALoadQuestionsOutput
NameDescriptionTypeAdditional information
KBAResponse

KBAResponse

None.

ReturnStatus

ReturnStatusModel

None.

Response Formats

application/json, text/json

Sample:
{
  "KBAResponse": {
    "error": "sample string 1",
    "kountTransactionId": "sample string 2",
    "inquiryId": "sample string 3",
    "authenticationId": "sample string 4",
    "questionnaireId": "sample string 5",
    "questions": [
      {
        "questionId": 1,
        "questionText": "sample string 2",
        "choiceType": "sample string 3",
        "choices": [
          {
            "choiceId": 1,
            "choiceText": "sample string 2",
            "isCorrect": true
          },
          {
            "choiceId": 1,
            "choiceText": "sample string 2",
            "isCorrect": true
          }
        ],
        "SelectedChoice": 4
      },
      {
        "questionId": 1,
        "questionText": "sample string 2",
        "choiceType": "sample string 3",
        "choices": [
          {
            "choiceId": 1,
            "choiceText": "sample string 2",
            "isCorrect": true
          },
          {
            "choiceId": 1,
            "choiceText": "sample string 2",
            "isCorrect": true
          }
        ],
        "SelectedChoice": 4
      }
    ]
  },
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:
<KBALoadQuestionsOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.Equifax.KBA">
  <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>
  <KBAResponse>
    <authenticationId>sample string 4</authenticationId>
    <error>sample string 1</error>
    <inquiryId>sample string 3</inquiryId>
    <kountTransactionId>sample string 2</kountTransactionId>
    <questionnaireId>sample string 5</questionnaireId>
    <questions>
      <Question>
        <SelectedChoice>4</SelectedChoice>
        <choiceType>sample string 3</choiceType>
        <choices>
          <Choice>
            <isCorrect>true</isCorrect>
            <label>sample string 2</label>
            <value>1</value>
          </Choice>
          <Choice>
            <isCorrect>true</isCorrect>
            <label>sample string 2</label>
            <value>1</value>
          </Choice>
        </choices>
        <questionId>1</questionId>
        <questionText>sample string 2</questionText>
      </Question>
      <Question>
        <SelectedChoice>4</SelectedChoice>
        <choiceType>sample string 3</choiceType>
        <choices>
          <Choice>
            <isCorrect>true</isCorrect>
            <label>sample string 2</label>
            <value>1</value>
          </Choice>
          <Choice>
            <isCorrect>true</isCorrect>
            <label>sample string 2</label>
            <value>1</value>
          </Choice>
        </choices>
        <questionId>1</questionId>
        <questionText>sample string 2</questionText>
      </Question>
    </questions>
  </KBAResponse>
</KBALoadQuestionsOutput>