Multi-Step Verification Workflows API v3.0

SOAP Service for Multi-Step Verification Workflows. This page includes description about service actions and data types.

MTOM is required by the SOAP server. Click here to access the Multi-Step Verification Workflows WSDL

Multi-Step Verification Workflows Service Functions

LoginResponseType Login (String username, String password)

Login using your Reseller or T-User username and password, and received a new sessionId in response. Each sessionId will expire in 10 minutes. You will use this sessionId in further function calls to complete the Identity Proofing.

MultiStepVerificationWorkflowResponseType CreateIndividualVerificationWorkflow (String sessionId, CreateVerificationWorkflowForm form, boolean withBranding )

Create a Verify Individual Workflow. If withBranding is true, then system will load branding template from form.template.

MultiStepVerificationWorkflowResponseType CreateHealthcareOrganizationVerificationWorkflow (String sessionId, CreateVerificationWorkflowForm form, boolean withBranding )

Create a Verify Healthcare Organization Workflow. If withBranding is true, then system will load branding template from form.template.

MultiStepVerificationWorkflowResponseType GetWorkflowById (String sessionId, long id )

Get multi-step workflow by id.

MultiStepVerificationWorkflowResponseType GetWorkflowsByReceiverEmail (String sessionId, String receiverEmail, boolean exactlyMatch )

Get multi-step workflows by receiver email address (Case in-sensitive). If exactlyMatch is false, system will match receiver's email that containing receiverEmail.

MultiStepVerificationWorkflowResponseType GetWorkflowsByOrganizationName (String sessionId, String organizationName, boolean exactlyMatch )

Get multi-step workflows by organization name (Case in-sensitive). If exactlyMatch is false, system will match organization names that containing organizationName.

MultiStepVerificationWorkflowResponseType GetWorkflowsByType (String sessionId, String workflowType )

Get multi-step workflows by workflow type (Case in-sensitive).

Healthcare Verification Service Data types

IDProofingResponseType

Parameter Description
Boolean success Whether the operation successfully completed. Required
String code Response code:
  • WS:001 - Missing parameters
  • WS:002 - Session invalid or expired
  • WS:003 - Payment failed
  • Auth:001 - Authentication failed.
  • Auth:010 - Authorization failed.
  • Console:001 - Generate Password Hash failed.
  • Console:099 - Failed when executing bridge console.
  • AP:1 - Can not register the person. It is already registered.
  • AP:2 - No person is loaded. Please register a person or find a registered person first.
  • AP:3 - Unnecessary Verification process. The person is already verified.
  • AP:4 - Unnecessary Authentication process. The person is already authenticated.
  • AP:5 - Unnecessary Multi-fact Authentication process. The person is already multi-fact authenticated.
  • AP:39 - Unnecessary Phone Verification process. This individual already has a mobile number been verified.
  • AP:6 - No person is found.
  • AP:7 - No transaction is found.
  • AP:8 - Person is not verified.
  • AP:40 - The person does not have a verified mobile number.
  • AP:9 - Person is not authenticated.
  • AP:10 - Person LexID is not found.
  • AP:11 - Missing parameter
  • AP:12 - Invalid parameter
  • AP:21 - Failed when calling Verification service.
  • AP:22 - Failed when calling Authentication service.
  • AP:23 - Failed when calling Multi-fact Authentication service EnrollSubject operation.
  • AP:24 - Failed when calling Multi-fact Authentication service QuerySubject operation.
  • AP:25 - Failed when calling Multi-fact Authentication service Generate One Time Password operation.
  • AP:26 - Failed when calling Multi-fact Authentication service Verify One Time Password operation.
  • AP:27 - Failed when calling Multi-fact Authentication service Verify Phone number operation.
  • AP:31 - Too many Generate One Time Password requests.
  • AP:33 - Too many Verify One Time Password requests.
  • AP:32 - Too many Verification requests.
  • AP:34 - Too many Verify Credit Card requests.
  • AP:35 - Invalid credit card number
  • AP:36 - Unsupported credit card type
  • AP:37 - Failed when verifying Credit Card
  • AP:38 - Too many Verify Phone number requests.
  • AP:51 - No organization is loaded. Please register an organization or find a registered organization first.
  • AP:52 - The submitted the healthcare information does not match the CMS NPI record.
  • AP:Notice:1 - The submitted organization name doesn't exactly match the CMS NPI record.
  • AP:53 - The CMS NPI Database connection is not configured.
  • AP:54 - Failed when query CMS NPI database. No content is responded.
  • AP:55 - Failed when query CMS NPI database. Unexpected HTTP Respnose Code
  • AP:DnB:1 - Failed when query D&B API. No content is responded.
  • AP:DnB:2 - Failed when query D&B API database. Unexpected HTTP Respnose Code
  • AP:DnB:3 - Failed to parse the D&B API response
  • AP:DnB:4 - Failed to authentication to D&B API
  • AP:DnB:5 - Unrecognized D&B API response code
  • AP:DnB:6 - Failed to match organization through D&B API
  • AP:DnB:7 - Failed to get organization details from D&B API
  • AP:DnB:8 - No organization is matched through D&B API
  • AP:DnB:9 - D-U-N-S number is missing
  • AP:DnB:10 - The submitted the organization information does not match the D&B record.
  • AP:Notice:2 - The submitted organization name doesn't exactly match the D&B record.
  • AP:DnB:11 - No organization is matched by the submited DUNS number
  • AP:55 - Failed to parse the CMS NPI query response.
  • AP:56 - No NPI record is found for number
  • AP:57 - Invalid NPI Type
  • AP:58 - Unnecessary Healthcare Verification process. The organization is already verified as Healthcare provider.
  • AP:SYS:9 - CMS NPI verification module is not found.
  • AP:SYS:10 - Memory Cache module is not found.
  • AP:SYS:11 - Session id is invalid or expired.
  • AP:SYS:12 - D&B Organization verification module is not found.
  • AP:59 - Too many Organization Healthcare Verification requests.
  • AP:60 - Can not register the organization. It is already registered.
  • AP:61 - Unnecessary Verification process. The organization is already verified
  • AP:62 - Too many Organization Verification requests.
  • AP:63 - Organization Type is missing.
  • AP:64 - Unrecognized Organization Type
  • AP:65 - Unexptected Organization Type
  • AP:DB:2 - Unable to create transaction in Database.
  • AP:DB:3 - Unable to update transaction in Database.
  • AP:DB:4 - Unable to update user status to Verified.
  • AP:DB:5 - Unable to update user status to Authenticated.
  • AP:DB:6 - Unable to update user status to Verified and Authenticated.
  • AP:DB:7 - Unable to update user status to Multi-fact Authenticated.
  • AP:DB:9 - Unable to update user status to Paid.
  • AP:DB:8 - Unable to update user configuration or profile.
  • AP:DB:10 - Unable to save confirmation code to Database.
  • AP:SYS:1 - Unable to encrypt or decrypt SSN.
  • AP:SYS:2 - Missing system parameter [role].
  • AP:SYS:3 - Missing system parameter [agent].
  • AP:SYS:4 - Unable to find the Verification credential.
  • AP:SYS:5 - Unable to find the Multi-fact Authentication credential.
  • AP:SYS:6 - Unable to read and decript the Verification credential.
  • AP:SYS:7 - Unable to read and decript the Multi-fact Authentication credential.
  • AP:SYS:8 - Credit card verification module is not found.
 Required
String message message
Top

LoginResponseType ( extends IDProofingResponseType )

Parameter Description
String sessionId A new sessionId that binding to the credential. Each sessionId will expire in 10 minutes. Required
Top

CreateVerificationWorkflowForm

Parameter Description
String template The name of workflow template. If withBranding is true, the template parameter will be ignored.
String orgName Organization name.
String receiverName Name of the person who will completed the workflow. Required
String receiverEmail Email address of the person who will completed the workflow. Required
boolean autoSendAlert Whether send out URL and notification of the workflow to receiver directly. Required
String completedRedirectUrl If completedRedirectUrl is set, user will be redirected to the given URL with below additional HTTP GET parameters after the workflow is completed.
  • id - unique ID of the workflow
  • workflow - workflow type
  • org_name - organization name that binding to the workflow (if any)
  • domain - Direct domain name that binding to the workflow (if any)
  • directAddress - Direct address that binding to the workflow (if any)
  • certified_org_id - verified organization record ID that binding to the workflow (if any)
  • certified_person_id - verified individual record ID that binding to the workflow (if any)
For example, if the given completedRedirectUrl is https://www.example.org/completed?status=succ, user would be redirect to URL like: https://www.example.org/completed?status=succ&id=1&workflow=VerifyPerson&org_name=ORG1&domain=&certified_org_id=0&certified_person_id=818 		Required
Top

VerificationWorkflow ( extends CreateVerificationWorkflowForm )

Parameter Description
long id Unique ID of the workflow Required
String workflowType Workflow Type Required
long certifiedOrgId Verified organization record ID that binding to the workflow (if any)
long certifiedPersonId Verified individual record ID that binding to the workflow (if any)
String tokenExpireTs Workflow expire timestamp in format YYYY-mm-dd HH:ii:ss in central time (like: 2016-01-01 20:01:01) Required
boolean expired Whether the workflow is expired Required
boolean completed Whether the workflow is completed Required
String createdTs Workflow created timestamp in format YYYY-mm-dd HH:ii:ss in central time (like: 2016-01-01 20:01:01) Required
String updatedTs Workflow created timestamp in format YYYY-mm-dd HH:ii:ss in central time (like: 2016-01-01 20:01:01) Required
String workflowUrl URL of the multi-step workflow Required
Top

MultiStepVerificationWorkflowResponseType ( extends IDProofingResponseType )

Parameter Description
VerificationWorkflow[ ] workflows An array of workflows
Top

IDOrganizationMeta

Parameter Description
long id unique id of the organization record
String name Organization name
String taxid Organization TaxID without dash or space
String state State of the organization location in two characters format (ex: NJ)
Top

IDHealthcareOrganizationInfo ( extends IDOrganizationMeta )

Parameter Description
String npi NPI number of the organization. Required
String recordCreatedDate Create date (YYYY-MM-DD) Required
String recordUpdatedDate Create date (YYYY-MM-DD) Required
IDProofingStatusType status Status of the ID Proofing flow with below possible values:
  • Registered - Organization record is saved into MaxMD database
  • HealthcareVerified - Organization healthcare information is verified
 Required
Top

IDOrganization ( extends IDOrganizationMeta )

Parameter Description
String npi NPI number of the organization. (without dash or space) Required
String street1 Street line 1 Required
String street2 Street line 2
String city City Required
String zip5 Zipcode of home address in five-character format (ex: 07024). Required
String country Country code in two-character format (ex: US). Required
String dea DEA number without dash or space
String medicalLicense reserved parameter
String medicalLicenseState reserved parameter
Top