POST dosconnect/NewApplicantIdentification

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
ApplicantID	integer	None.
Identification	UpdateIdentificationModel	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "ApplicantID": 2,
  "Identification": {
    "IdentificationTypeDD": 1,
    "Country": "sample string 1",
    "IdentificationNumber": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<NewApplicantIdentificationInput 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>
  <ApplicantID>2</ApplicantID>
  <Identification>
    <Country>sample string 1</Country>
    <IdentificationNumber>sample string 2</IdentificationNumber>
    <IdentificationTypeDD>1</IdentificationTypeDD>
  </Identification>
</NewApplicantIdentificationInput>

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

Response Information

Resource Description

NewApplicantIdentificationOutput

Name	Description	Type	Additional information
IdentificationID		integer	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "IdentificationID": 1,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<NewApplicantIdentificationOutput 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>
  <IdentificationID>1</IdentificationID>
</NewApplicantIdentificationOutput>