POST api/clinicians/idp

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FirstName	string	Required
MiddleName	string	String length: inclusive between 0 and 35
LastName	string	Required
HomeAddress	string	Required
City	string	Required
State	string	Required
ZipCode	string	Required
DateOfBirth	date	Required
SocialSecurityNumber	string	Required
CreditCardNumber	string	Required
DrivingLicenseNumber	string	None.
DrivingLicenseNumberState	string	None.
PhoneNumber	string	Required
IsMobileNumber	boolean	Required
Gender	string	None.
YearOfBirth	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "MiddleName": "sample string 2",
  "LastName": "sample string 3",
  "HomeAddress": "sample string 4",
  "City": "sample string 5",
  "State": "sample string 6",
  "ZipCode": "sample string 7",
  "DateOfBirth": "2024-05-18T19:36:10.6672215+00:00",
  "SocialSecurityNumber": "sample string 9",
  "CreditCardNumber": "sample string 10",
  "DrivingLicenseNumber": "sample string 11",
  "DrivingLicenseNumberState": "sample string 12",
  "PhoneNumber": "sample string 13",
  "IsMobileNumber": true,
  "Gender": "sample string 15",
  "YearOfBirth": "sample string 16"
}

application/xml, text/xml

Sample:

<ClinicianIdentityProofingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <City>sample string 5</City>
  <CreditCardNumber>sample string 10</CreditCardNumber>
  <DateOfBirth>2024-05-18T19:36:10.6672215+00:00</DateOfBirth>
  <DrivingLicenseNumber>sample string 11</DrivingLicenseNumber>
  <DrivingLicenseNumberState>sample string 12</DrivingLicenseNumberState>
  <FirstName>sample string 1</FirstName>
  <Gender>sample string 15</Gender>
  <HomeAddress>sample string 4</HomeAddress>
  <IsMobileNumber>true</IsMobileNumber>
  <LastName>sample string 3</LastName>
  <MiddleName>sample string 2</MiddleName>
  <PhoneNumber>sample string 13</PhoneNumber>
  <SocialSecurityNumber>sample string 9</SocialSecurityNumber>
  <State>sample string 6</State>
  <YearOfBirth>sample string 16</YearOfBirth>
  <ZipCode>sample string 7</ZipCode>
</ClinicianIdentityProofingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClinicianIdentityProofingResponse

Name	Type	Additional information
SessionID	string	None.
Questions	Collection of string	None.
Answers	Collection of Collection of string	None.
OtpSent	boolean	None.
IdpResultSummary	string	None.
Result	Result	None.

Response Formats

application/json, text/json

Sample:

{
  "SessionID": "sample string 1",
  "Questions": [
    "sample string 1",
    "sample string 2"
  ],
  "Answers": [
    [
      "sample string 1",
      "sample string 2"
    ],
    [
      "sample string 1",
      "sample string 2"
    ]
  ],
  "OtpSent": true,
  "IdpResultSummary": "sample string 3",
  "Result": {
    "ResultCode": "sample string 1",
    "ResultDescription": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<ClinicianIdentityProofingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DoseSpot.UI.API.DataContracts._13">
  <Result>
    <ResultCode>sample string 1</ResultCode>
    <ResultDescription>sample string 2</ResultDescription>
  </Result>
  <Answers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
    </d2p1:ArrayOfstring>
    <d2p1:ArrayOfstring>
      <d2p1:string>sample string 1</d2p1:string>
      <d2p1:string>sample string 2</d2p1:string>
    </d2p1:ArrayOfstring>
  </Answers>
  <IdpResultSummary>sample string 3</IdpResultSummary>
  <OtpSent>true</OtpSent>
  <Questions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Questions>
  <SessionID>sample string 1</SessionID>
</ClinicianIdentityProofingResponse>