POST dosconnect/NewApplicantGroup

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
MortgageApplicationID	integer	None.
ApplicantGroup	UpdateNewApplicantGroupModel	None.
Applicant1	UpdateFirstApplicantModel	None.
Applicant2	UpdateSecondApplicantModel	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "MortgageApplicationID": 2,
  "ApplicantGroup": {
    "MailingAddress": {
      "AddressID": 1,
      "UnitNumber": "sample string 2",
      "StreetNumber": "sample string 3",
      "StreetName": "sample string 4",
      "StreetTypeDD": 1,
      "StreetDirectionDD": 1,
      "City": "sample string 5",
      "ProvinceDD": 1,
      "InternationalPostalCode": "sample string 6",
      "PostalFsa": "sample string 7",
      "PostalLdu": "sample string 8",
      "CountryTypeDD": 1
    },
    "OtherIncomes": [
      {
        "IncomeTypeDD": 1,
        "IncomePeriodDD": 1,
        "IncomeAmount": 1.0,
        "AnnualIncomeAmount": 2.0,
        "IncomeDescription": "sample string 3"
      },
      {
        "IncomeTypeDD": 1,
        "IncomePeriodDD": 1,
        "IncomeAmount": 1.0,
        "AnnualIncomeAmount": 2.0,
        "IncomeDescription": "sample string 3"
      }
    ],
    "MailingAddressTypeDD": 1,
    "ApplicantsHasSameAddressFlag": true,
    "ApplicantGroupTypeDD": 2
  },
  "Applicant1": {
    "HomePhone": "sample string 1",
    "Dependents": "sample string 2",
    "LanguagePreferenceDD": 1,
    "ExistingClientFlag": true,
    "ClientNumber": "sample string 3",
    "FirstTimeBuyerFlag": true,
    "RelationShipDD": 1,
    "SalutationDD": 1,
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "MiddleInitial": "sample string 6",
    "SuffixDD": 1,
    "DOB": "2025-12-15T22:53:08.4651485-05:00",
    "SIN": "sample string 7",
    "MaritalStatusDD": 1,
    "EmailAddress": "sample string 8",
    "PreferredContactMethodDD": 1,
    "WorkPhone": "sample string 9",
    "WorkPhoneExt": "sample string 10",
    "CellPhone": "sample string 11",
    "FAX": "sample string 12",
    "PrimaryFlag": true
  },
  "Applicant2": {
    "SalutationDD": 1,
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "MiddleInitial": "sample string 3",
    "SuffixDD": 1,
    "DOB": "2025-12-15T22:53:08.4651485-05:00",
    "SIN": "sample string 4",
    "MaritalStatusDD": 1,
    "EmailAddress": "sample string 5",
    "PreferredContactMethodDD": 1,
    "WorkPhone": "sample string 6",
    "WorkPhoneExt": "sample string 7",
    "CellPhone": "sample string 8",
    "FAX": "sample string 9",
    "PrimaryFlag": true
  }
}

application/xml, text/xml

Sample:

<NewApplicantGroupInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <APIKey>sample string 1</APIKey>
  <Applicant1>
    <CellPhone>sample string 11</CellPhone>
    <DOB>2025-12-15T22:53:08.4651485-05:00</DOB>
    <EmailAddress>sample string 8</EmailAddress>
    <FAX>sample string 12</FAX>
    <FirstName>sample string 4</FirstName>
    <LastName>sample string 5</LastName>
    <MaritalStatusDD>1</MaritalStatusDD>
    <MiddleInitial>sample string 6</MiddleInitial>
    <PreferredContactMethodDD>1</PreferredContactMethodDD>
    <PrimaryFlag>true</PrimaryFlag>
    <SIN>sample string 7</SIN>
    <SalutationDD>1</SalutationDD>
    <SuffixDD>1</SuffixDD>
    <WorkPhone>sample string 9</WorkPhone>
    <WorkPhoneExt>sample string 10</WorkPhoneExt>
    <ClientNumber>sample string 3</ClientNumber>
    <Dependents>sample string 2</Dependents>
    <ExistingClientFlag>true</ExistingClientFlag>
    <FirstTimeBuyerFlag>true</FirstTimeBuyerFlag>
    <HomePhone>sample string 1</HomePhone>
    <LanguagePreferenceDD>1</LanguagePreferenceDD>
    <RelationShipDD>1</RelationShipDD>
  </Applicant1>
  <Applicant2>
    <CellPhone>sample string 8</CellPhone>
    <DOB>2025-12-15T22:53:08.4651485-05:00</DOB>
    <EmailAddress>sample string 5</EmailAddress>
    <FAX>sample string 9</FAX>
    <FirstName>sample string 1</FirstName>
    <LastName>sample string 2</LastName>
    <MaritalStatusDD>1</MaritalStatusDD>
    <MiddleInitial>sample string 3</MiddleInitial>
    <PreferredContactMethodDD>1</PreferredContactMethodDD>
    <PrimaryFlag>true</PrimaryFlag>
    <SIN>sample string 4</SIN>
    <SalutationDD>1</SalutationDD>
    <SuffixDD>1</SuffixDD>
    <WorkPhone>sample string 6</WorkPhone>
    <WorkPhoneExt>sample string 7</WorkPhoneExt>
  </Applicant2>
  <ApplicantGroup>
    <ApplicantGroupTypeDD>2</ApplicantGroupTypeDD>
    <ApplicantsHasSameAddressFlag>true</ApplicantsHasSameAddressFlag>
    <MailingAddressTypeDD>1</MailingAddressTypeDD>
    <MailingAddress>
      <AddressID>1</AddressID>
      <City>sample string 5</City>
      <CountryTypeDD>1</CountryTypeDD>
      <InternationalPostalCode>sample string 6</InternationalPostalCode>
      <PostalFsa>sample string 7</PostalFsa>
      <PostalLdu>sample string 8</PostalLdu>
      <ProvinceDD>1</ProvinceDD>
      <StreetDirectionDD>1</StreetDirectionDD>
      <StreetName>sample string 4</StreetName>
      <StreetNumber>sample string 3</StreetNumber>
      <StreetTypeDD>1</StreetTypeDD>
      <UnitNumber>sample string 2</UnitNumber>
    </MailingAddress>
    <OtherIncomes>
      <UpdateIncomeModel>
        <AnnualIncomeAmount>2</AnnualIncomeAmount>
        <IncomeAmount>1</IncomeAmount>
        <IncomeDescription>sample string 3</IncomeDescription>
        <IncomePeriodDD>1</IncomePeriodDD>
        <IncomeTypeDD>1</IncomeTypeDD>
      </UpdateIncomeModel>
      <UpdateIncomeModel>
        <AnnualIncomeAmount>2</AnnualIncomeAmount>
        <IncomeAmount>1</IncomeAmount>
        <IncomeDescription>sample string 3</IncomeDescription>
        <IncomePeriodDD>1</IncomePeriodDD>
        <IncomeTypeDD>1</IncomeTypeDD>
      </UpdateIncomeModel>
    </OtherIncomes>
  </ApplicantGroup>
  <MortgageApplicationID>2</MortgageApplicationID>
</NewApplicantGroupInput>

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

Response Information

Resource Description

NewApplicantGroupOutput

Name	Type	Additional information
ApplicantGroupID	integer	None.
Applicant1ID	integer	None.
Applicant2ID	integer	None.
ReturnStatus	ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ApplicantGroupID": 1,
  "Applicant1ID": 2,
  "Applicant2ID": 1,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<NewApplicantGroupOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <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>
  <Applicant1ID>2</Applicant1ID>
  <Applicant2ID>1</Applicant2ID>
  <ApplicantGroupID>1</ApplicantGroupID>
</NewApplicantGroupOutput>