Response Details

FieldTypeLengthShort DescriptionDescription
CorrelationIdstring36Correlation IDCorrelation identifier for tracking the transaction end-to-end
ErrorstringVariableError message, if anyError message describing why the request could not be processed, if applicable
ClientMemberobjectN/AMatched member identityIdentity information for the Member who was inquired about, as matched by the system
PoliciesCobPolicy (List)N/AList of matched policiesList of coverage/policy records identified for the Member
IdentityMatchProbabilityScorestringVariableIdentity match confidence scoreConfidence score indicating how closely the matched identity aligns with the request
PrimacyScoreintUp to 10 digitsPrimacy ranking scoreScore used to determine the primacy/order-of-benefits ranking
RequestIdstringVariableEchoed correlation IDEchoes the RequestId supplied on the request
ResponseIdguid36Unique response IDUnique identifier generated for this response
CustomCustomN/AOptional custom key/value dataIn a "custom" object, listed as "propName": "value"
ClientMember.Addr1stringVariableMember's address line 1First line of the mailing address for the Member
ClientMember.Addr2stringVariableMember's address line 2Second line of the mailing address for the Member
ClientMember.CitystringVariableMember's cityCity of the Member's mailing address
ClientMember.DobDateonly10Member's date of birthDate of Birth of the Member
ClientMember.FirstNamestringVariableMember's first nameFirst Name of the Member
ClientMember.GenderstringVariableMember's genderGender of the Member
ClientMember.LastNamestringVariableMember's last nameLast Name of the Member
ClientMember.MiddleNamestringVariableMember's middle nameMiddle Name of the Member
ClientMember.SSNstringVariableMember's SSNSocial Security Number of the Member
ClientMember.Statestring2Member's stateTwo-letter state code of the Member's mailing address
ClientMember.ZipstringVariableMember's zipZIP code of the Member's mailing address
ClientMember.PhonestringVariableMember's phone numberPhone number of the Member
ClientMember.EmailstringVariableMember's email addressEmail address of the Member
Policies[].BinstringVariableCarrier Bank ID NumberBank Identification Number for the pharmacy benefit/carrier
Policies[].CarrierNamestringVariableCarrier nameName of the insurance carrier providing coverage
Policies[].CoverageTypeTypeVariableCoverage type codeCode identifying the type of coverage
Policies[].CoverageTypeDescstringVariableCoverage type descriptionDescription of the coverage type
Policies[].CoverageTypeGrpstringVariableCoverage type groupGroup/category the coverage type belongs to
Policies[].OhiEffectiveDateDateOnly10OHI effective dateDate the other health insurance (OHI) coverage became effective
Policies[].OhiTerminationDateDateOnly10OHI termination dateDate the other health insurance (OHI) coverage terminated
Policies[].GroupNamestringVariableBenefit group nameName of the employer/benefit group associated with the policy
Policies[].GroupNumberstringVariableBenefit group numberNumber identifying the employer/benefit group associated with the policy
Policies[].MemberCobMemberN/ACovered member identityIdentity information for the covered Member on this policy
Policies[].PolicyHolderCobMemberN/APolicyholder identityIdentity information for the policyholder of this policy
Policies[].PcnstringVariableProcessor Control NumberProcessor Control Number used for pharmacy claims routing
Policies[].PolicyIdstringVariablePolicy IDUnique identifier for the policy
Policies[].PolicyPersonCodestringVariablePolicy person codeCode identifying the covered person's role on the policy
Policies[].RelationshipstringVariableMember's relationship to policyholderRelationship of the Member to the policyholder
Policies[].SubGroupNumberstringVariableBenefit sub-group numberNumber identifying the sub-group associated with the policy
Policies[].OrderOfBenefitsintUp to 10 digitsBenefit order/primacy rankNumeric order used to determine primacy of benefits
Policies[].PayerNamestringVariablePayer nameName of the payer responsible for the policy
Policies[].Member.Addr1stringVariableCovered member address line 1First address line for the covered member on this policy
Policies[].Member.Addr2stringVariableCovered member address line 2Second address line for the covered member on this policy
Policies[].Member.CitystringVariableCovered Member's cityCity for the covered member on this policy
Policies[].Member.DobDateonly10Covered member DOBDate of birth for the covered member on this policy
Policies[].Member.FirstNamestringVariableCovered member first nameFirst name for the covered member on this policy
Policies[].Member.GenderstringVariableCovered member genderGender for the covered member on this policy
Policies[].Member.LastNamestringVariableCovered member last nameLast name for the covered member on this policy
Policies[].Member.MiddleNamestringVariableCovered member middle nameMiddle name for the covered member on this policy
Policies[].Member.SSNstringVariableCovered member SSNSocial Security Number for the covered member on this policy
Policies[].Member.Statestring2Covered member stateTwo-letter state code for the covered member on this policy
Policies[].Member.ZipstringVariableCovered member ZIPZIP code for the covered member on this policy
Policies[].Member.PhonestringVariableCovered member phonePhone number for the covered member on this policy
Policies[].Member.EmailstringVariableCovered member emailEmail address for the covered member on this policy
Policies[].PolicyHolder.Addr1stringVariablePolicyholder address line 1First address line for the policyholder on this policy
Policies[].PolicyHolder.Addr2stringVariablePolicyholder address line 2Second address line for the policyholder on this policy
Policies[].PolicyHolder.CitystringVariablePolicyholder cityCity for the policyholder on this policy
Policies[].PolicyHolder.DobDateonly10Policyholder DOBDate of birth for the policyholder on this policy
Policies[].PolicyHolder.FirstNamestringVariablePolicyholder first nameFirst name for the policyholder on this policy
Policies[].PolicyHolder.GenderstringVariablePolicyholder genderGender for the policyholder on this policy
Policies[].PolicyHolder.LastNamestringVariablePolicyholder last nameLast name for the policyholder on this policy
Policies[].PolicyHolder.MiddleNamestringVariablePolicyholder middle nameMiddle name for the policyholder on this policy
Policies[].PolicyHolder.SSNstringVariablePolicyholder SSNSocial Security Number for the policyholder on this policy
Policies[].PolicyHolder.Statestring2Policyholder stateTwo-letter state code for the policyholder on this policy
Policies[].PolicyHolder.ZipstringVariablePolicyholder ZIPZIP code for the policyholder on this policy
Policies[].PolicyHolder.PhonestringVariablePolicyholder phonePhone number for the policyholder on this policy
Policies[].PolicyHolder.EmailstringVariablePolicyholder emailEmail address for the policyholder on this policy