Organization Verification API v3.0

SOAP Service for automatic LoA3 Identify Proofing Service. This page includes description about service actions and data types.

MTOM is required by the SOAP server. Click here to access the Organization Verification Workflows WSDL

Organization Verification 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.

OrganizationVerificationResponseType VerifyOrganization (String sessionId, IDOrganization organization )

Verify submitted organization information through D&B database. organization.organizationType should be HE (Healthcare Entity) or BA (Business Associate) . organization.duns (D&B D-U-N-S number) is required.
The status will be returned as response.verificationStatus

OrganizationVerificationResponseType VerifyHealthcareOrganization (String sessionId, IDOrganization organization )

Verify health care information for the submitted organization through CMS NPI database. organization.organizationType should be CE (Covered Entity). organization.npi is required.
The status will be returned as response.healthcareVerificationStatus

OrganizationVerificationResponseType VerifyOrganizationWithDetails (String sessionId, IDOrganizationWithDetails organization )

Verify submitted organization information through D&B database. organization.organizationType should be HE (Healthcare Entity) or BA (Business Associate) . organization.duns (D&B D-U-N-S number) is required.
The status will be returned as response.verificationStatus

OrganizationVerificationResponseType VerifyHealthcareOrganizationWithDetails (String sessionId, IDOrganizationWithDetails organization )

Verify health care information for the submitted organization through CMS NPI database. organization.organizationType should be CE (Covered Entity). organization.npi is required.
The status will be returned as response.healthcareVerificationStatus

GetRegisteredOrganizationsResponseType GetRegisteredOrganizations (String sessionId, boolean verifiedOnly)

Get a list of registered organizations.

OrganizationVerificationResponseType SaveCertifiedOrganization (String sessionId, IDOrganization organization )

TrustedAgent TrustedAgent could call this funciton to save Verified Organization record.

OrganizationVerificationResponseType SaveCertifiedOrganizationWithDetails (String sessionId, IDOrganizationWithDetails organization )

TrustedAgent TrustedAgent could call this funciton to save Verified Organization record.

Organization 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:66 - Unnecessary Healthcare Verification process. The person's healthcare information has already been verified.
  • 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:72 - One Time Password manager is not configured.
  • AP:73 - Failed when send SMS message. Unexpected HTTP Respnose Code
  • AP:25 - Failed to Generate One Time Password.
  • AP:26 - Failed to Verify One Time Password.
  • 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:68 - Failed when verifying Healthcare information.
  • 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:Notice:3 - The submitted individual 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:CNAM:1 - Failed to compose Mobile number verification query
  • AP:CNAM:2 - Failed when query CNAM API. No content is responded.
  • AP:CNAM:3 - Failed to parse CNAM Query Response.
  • AP:CNAM:4 - Verify Phone number failed.
  • AP:70 - Unable to save certified organization, the credential is not Trusted Agent.
  • AP:71 - Unable to save ID Proofed individual, the credential is not Trusted Agent.
  • AP:69 - 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:67 - Too many Individual 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:11 - Unable to update user status to Provider Verified.
  • 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:DB:11 - Unable to update organization verification status.
  • 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.
  • BS:001 - Internal Error. No operation and data is found.
  • BS:002 - Internal Error. No input parameter file is found.
  • BS:003 - Internal Error. Invalid operation data.
  • BS:004 - Internal Error. Missing parameter.
  • BS:010 - Authentication failed. Username or password is incorrect.
  • BS:011 - Authentication failed. Invalid Session id.
  • BS:012 - Internal Error. Permission denied.
  • BS:013 - Internal Error. Unable to load Reseller object from the TUser.
  • BS:P:999 - Failed when running payment process.
 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

OrganizationVerificationResponseType ( extends IDProofingResponseType )

Parameter Description
IDPersonMeta personMeta Reserved parameter.
IDOrganizationMeta organizationMeta Organization information. This parameter will be empty if it's verifying personal health care information
OrganizationVerificationStatusType healthcareVerificationStatus Status of the healthcare information verification with the following values:
  • Init - Initial
  • Registered - Organization record is saved into MaxMD database
  • NameFuzzyMatched - Organization name doesn't exactly match the D&B record. Other information is all verified.
  • Verified - Organization information is verified
OrganizationVerificationStatusType verificationStatus Status of the organization verification with the following values:
  • Init - Initial
  • Registered - Organization record is saved into MaxMD database
  • NameFuzzyMatched - Organization name doesn't exactly match the D&B record. Other information is all verified.
  • Verified - Organization information is verified
String confirmationCode Confirmation code
String expectedOrganizationName Exact organization name in the CMS NPI database or D&B database. This parameter is returned when verificationStatus/healthcareVerificationStatus is NameFuzzyMatched.
Top

GetRegisteredOrganizationsResponseType ( extends IDProofingResponseType )

Parameter Description
IDOrganizationInfoCollection[ ] organizations Matched organization records
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

IDOrganizationInfoCollection ( extends IDOrganizationMeta )

Parameter Description
String npi NPI number of the organization. Required
String duns D&B D-U-N-S® Number Required
String organizationType
  • CE - Covered Entity
  • HE - Healthcare Entity
  • BA - Business Associate
 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 duns D&B D-U-N-S® Number Required
String organizationType
  • CE - Covered Entity
  • HE - Healthcare Entity
  • BA - Business Associate
 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

IDOrganizationWithDetails ( extends IDOrganization )

Parameter Description
Map<String, String> verifiedDetails Customized organization settings using key value pair
Map<String, String> providerVerifiedDetails Customized provider settings within the organization using key value pair
Top