POST Orders/Validate

Validates an orderrequest and returns any issues the request might have along with a requirement matrix output.

Request Information

URI Parameters

None.

Body Parameters

An Order Request object

Name	Description	Type	Additional information
ReferenceNumber	A value that a placing party uses to track the incoming order on SMM's systems.	string	Matching regular expression pattern: ^[^<>;#]*$
FirstName	The first name of the applicant of the order being requested.	string	Matching regular expression pattern: ^[^<>;#]*$
LastName	The last name of the applicant of the order being requested.	string	Matching regular expression pattern: ^[^<>;#]*$
Gender	The gender of the applicant, valid values are: Male, Female, M, F.	string	Matching regular expression pattern: ^[^<>;#]*$
PolicyNumber	The policy number of the policy being applied for. This can be left blank or ommitted.	string	Matching regular expression pattern: ^[^<>;#]*$
Product	The insurance carrier product being applied for.	Product	None.
DOB	The applicant's date of birth. Can be in many different datetime parseable formats ie: MM/dd/yyyy, MM-dd-yyyy, etc..	string	Matching regular expression pattern: ^[^<>;#]*$
Phone	A primary phone number that can be used to contact the applicant.	string	Matching regular expression pattern: ^[^<>;#]*$
ApplicantEmail	The applicant's email address to be used for appointment, notification, and document signature purposes.	string	Matching regular expression pattern: ^[^<>;#]*$
Notes	Notes that will be added to the order for SMM representatives to take heed of.	string	Matching regular expression pattern: ^[^<>;#]*$
FaceAmount	The face amount of the policy being applied for.	string	Matching regular expression pattern: ^[^<>;#]*$
SmokerStatus	The smoker status of the applicant, valid values are: Current User, Never Used.	string	Matching regular expression pattern: ^[^<>;#]*$
AddressLine1	Address Line 1 of where the applicant will have the exam appointment.	string	Matching regular expression pattern: ^[^<>;#]*$
AddressLine2	Address Line 2 of where the applicant will have the exam appointment.	string	Matching regular expression pattern: ^[^<>;#]*$
City	Address city of where the applicant will have the exam appointment.	string	Matching regular expression pattern: ^[^<>;#]*$
State	Address state of where the applicant will have the exam appointment.	string	Matching regular expression pattern: ^[^<>;#]*$
Zip	Address zip of where the applicant will have the exam appointment.	string	Matching regular expression pattern: ^[^<>;#]*$
AgencyNumber	The agency's account number with the insurance carrier, this field can be left blank or ommitted.	string	Matching regular expression pattern: ^[^<>;#]*$
AgentNumber	The agent's account number with the insurance carrier, this field can be left blank or ommitted.	string	Matching regular expression pattern: ^[^<>;#]*$
TestMode	If test mode is set to true, the order will be marked as a test and will not be processed normally but will show up for SMM order reps to validate data upon request.	boolean	None.
Agency	A record for the agency on the order.	Agency	None.
Agent	A record for the agent on the order.	Agent	None.
OrderFor	If using SMM's full user access system for gathering user access rights before placing an order, the OrderFor record places an order directly for a pre-existing SMM record, streamlining the SMM order placement process. This record can be ommitted if the agent and agency records are present.	PartyUserAccess	None.
LinkParty	If using SMM's full user access system for gathering user access rights before placing an order, the LinkParty record places an order directly for a pre-existing SMM record, streamlining the SMM order placement process. This record can be ommitted if the agent and agency records are present.	PartyUserLink	None.
Carrier	A record for the Carrier on the order.	CarrierDTO	None.
PrimaryBeneficiary	The primary beneficiary for the policy.	OrderBeneficiary	None.
SecondaryBeneficiary	The secondary Beneficiary for the policy.	OrderBeneficiary	None.

Request Formats

application/json, text/json

Sample:

{
  "ReferenceNumber": "sample string 1",
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Gender": "sample string 4",
  "PolicyNumber": "sample string 5",
  "Product": {
    "ID": 1,
    "ReqMatrixID": "sample string 1",
    "Name": "sample string 2",
    "LineOfBusiness": "sample string 3",
    "TypeOfBusiness": "sample string 4"
  },
  "DOB": "sample string 6",
  "Phone": "sample string 7",
  "ApplicantEmail": "sample string 8",
  "Notes": "sample string 9",
  "FaceAmount": "sample string 10",
  "SmokerStatus": "sample string 11",
  "AddressLine1": "sample string 12",
  "AddressLine2": "sample string 13",
  "City": "sample string 14",
  "State": "sample string 15",
  "Zip": "sample string 16",
  "AgencyNumber": "sample string 17",
  "AgentNumber": "sample string 18",
  "TestMode": true,
  "Agency": {
    "AgencyID": 1,
    "AgencyFullName": "sample string 2",
    "AddressLine1": "sample string 3",
    "Suite": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7",
    "PhoneNumber": "sample string 8",
    "Extension": "sample string 9",
    "EmailAddress": "sample string 10",
    "CreateDate": "2024-11-22T22:02:09.5863246-06:00",
    "IsActive": true
  },
  "Agent": {
    "AgentID": 1,
    "AgentFullName": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "AddressLine1": "sample string 5",
    "Suite": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "Zip": "sample string 9",
    "PhoneNumber": "sample string 10",
    "Extension": "sample string 11",
    "EmailAddress": "sample string 12",
    "CreateDate": "2024-11-22T22:02:09.5863246-06:00",
    "IsActive": true
  },
  "OrderFor": {
    "PUApk": "sample string 1",
    "PartyName": "sample string 2",
    "PartyID": 3,
    "PartyType": "sample string 4",
    "PartyTypeID": 5
  },
  "LinkParty": {
    "PartyName": "sample string 1",
    "PartyID": 2,
    "PartyType": "sample string 3",
    "PartyTypeID": 4
  },
  "Carrier": {
    "CarrierID": 1,
    "Name": "sample string 1"
  },
  "PrimaryBeneficiary": {
    "Name": "sample string 1",
    "BeneficiaryType": "sample string 2",
    "Percentage": 3.1
  },
  "SecondaryBeneficiary": {
    "Name": "sample string 1",
    "BeneficiaryType": "sample string 2",
    "Percentage": 3.1
  }
}

application/xml, text/xml

Sample:

<OrderRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ReferenceNumber>sample string 1</ReferenceNumber>
  <FirstName>sample string 2</FirstName>
  <LastName>sample string 3</LastName>
  <Gender>sample string 4</Gender>
  <PolicyNumber>sample string 5</PolicyNumber>
  <Product>
    <ID>1</ID>
    <ReqMatrixID>sample string 1</ReqMatrixID>
    <Name>sample string 2</Name>
    <LineOfBusiness>sample string 3</LineOfBusiness>
    <TypeOfBusiness>sample string 4</TypeOfBusiness>
  </Product>
  <DOB>sample string 6</DOB>
  <Phone>sample string 7</Phone>
  <ApplicantEmail>sample string 8</ApplicantEmail>
  <Notes>sample string 9</Notes>
  <FaceAmount>sample string 10</FaceAmount>
  <SmokerStatus>sample string 11</SmokerStatus>
  <AddressLine1>sample string 12</AddressLine1>
  <AddressLine2>sample string 13</AddressLine2>
  <City>sample string 14</City>
  <State>sample string 15</State>
  <Zip>sample string 16</Zip>
  <AgencyNumber>sample string 17</AgencyNumber>
  <AgentNumber>sample string 18</AgentNumber>
  <TestMode>true</TestMode>
  <Agency>
    <AgencyID>1</AgencyID>
    <AgencyFullName>sample string 2</AgencyFullName>
    <AddressLine1>sample string 3</AddressLine1>
    <Suite>sample string 4</Suite>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <Zip>sample string 7</Zip>
    <PhoneNumber>sample string 8</PhoneNumber>
    <Extension>sample string 9</Extension>
    <EmailAddress>sample string 10</EmailAddress>
    <CreateDate>2024-11-22T22:02:09.5863246-06:00</CreateDate>
    <IsActive>true</IsActive>
  </Agency>
  <Agent>
    <AgentID>1</AgentID>
    <AgentFullName>sample string 2</AgentFullName>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 4</LastName>
    <AddressLine1>sample string 5</AddressLine1>
    <Suite>sample string 6</Suite>
    <City>sample string 7</City>
    <State>sample string 8</State>
    <Zip>sample string 9</Zip>
    <PhoneNumber>sample string 10</PhoneNumber>
    <Extension>sample string 11</Extension>
    <EmailAddress>sample string 12</EmailAddress>
    <CreateDate>2024-11-22T22:02:09.5863246-06:00</CreateDate>
    <IsActive>true</IsActive>
  </Agent>
  <OrderFor>
    <PartyName>sample string 2</PartyName>
    <PartyID>3</PartyID>
    <PartyType>sample string 4</PartyType>
    <PartyTypeID>5</PartyTypeID>
    <PUApk>sample string 1</PUApk>
  </OrderFor>
  <LinkParty>
    <PartyName>sample string 1</PartyName>
    <PartyID>2</PartyID>
    <PartyType>sample string 3</PartyType>
    <PartyTypeID>4</PartyTypeID>
  </LinkParty>
  <Carrier>
    <CarrierID>1</CarrierID>
    <Name>sample string 1</Name>
  </Carrier>
  <PrimaryBeneficiary>
    <Name>sample string 1</Name>
    <BeneficiaryType>sample string 2</BeneficiaryType>
    <Percentage>3.1</Percentage>
  </PrimaryBeneficiary>
  <SecondaryBeneficiary>
    <Name>sample string 1</Name>
    <BeneficiaryType>sample string 2</BeneficiaryType>
    <Percentage>3.1</Percentage>
  </SecondaryBeneficiary>
</OrderRequest>

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

Response Information

Resource Description

OrderRequestResponse

Name	Description	Type	Additional information
Success	Whether or not the request was successsful.	boolean	None.
ReqMatrixSuccess	True if requirements were able to be pulled based on the data sent in.	boolean	None.
OrderID	An SMM order ID that can be used as a reference throughout the order's lifecycle.	integer	None.
RequirementsLine1	If the requirements were pulled, this is the first line of requirements - IE: Paramed, Blood, HOS	string	None.
RequirementsLine2	If the requirements were pulled, this is the second line of requirements - IE: HIV Consent.	string	None.
Errors	If errors were encountered while placing the order, the details will be included here.	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ReqMatrixSuccess": true,
  "OrderID": 3,
  "RequirementsLine1": "sample string 4",
  "RequirementsLine2": "sample string 5",
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}