Real Coordination of Benefits Intelligence

Product overview

Transform healthcare claims processing with our Real-Time Coordination of Benefits (COB) API (RTCOB API). Our solution enhances healthcare claims processing by providing providers with real-time access to a comprehensive dataset of eligibility records across various health policies. This helps providers bill the correct plan from the start, saving provider staff time and avoiding unnecessary administrative costs due to denials and rebilling.

📘

Notes

The RTCOB API has following two API service endpoints:

  • lookup Endpoint: This endpoint is used to retrieve member details and related information
  • dep/pay-or-deny Endpoint: This endpoint is used to determine whether a request should be approved for pay or deny.

Lookup Endpoint

Workflow:

The diagram illustrates the end-to-end request processing flow at a high level. A customer or business user submits a request either in real-time through the API Endpoint for immediate processing, or in bulk via a Queue for high-volume batch scenarios. Regardless of the submission path, the system validates the member's eligibility and determines their primary coverage by cross-referencing account details and member information. Once processing is complete, the coverage result is returned to the requester.

Request Details:

FieldTypeLengthDescriptionRequiredShort Description
RequestIdstring50Correlation identifier that the requestor provides, returned in responseYesCaller-supplied correlation ID
ClientIdstring (guid)NAmust be in guid formatYesClient GUID
ConsumerIdstring (guid)NAmust be in guid formatYesConsumer GUID
MemberInformationCobMember50Container holding the details of the Member who was inquired aboutYesMember detail object
CustomCustomNAIn a "custom" object, listed as "propname": "value"NoOptional custom key/value data
MemberInformation.FirstNamestring128First Name of Member who was inquired aboutYesMember's first name
MemberInformation.MiddleNamestring128Middle Name of Member who was inquired aboutNoMember's middle name
MemberInformation.LastNamestring128Last Name of Member who was inquired aboutYesMember's last name
MemberInformation.DateOfBirthstringNADate of Birth of Member who was inquired about; must be a valid dateYesMember's date of birth
MemberInformation.Genderstring1Gender of Member who was inquired aboutNoMember's gender
MemberInformation.SSNstring9If exists, must be 9 digitsNoMember's Social Security Number
MemberInformation.AddressLineOnestring50First line of the mailing address for the Member who was inquired aboutNoMember's address line 1
MemberInformation.AddressLineTwostring50Second line of the mailing address for the Member who was inquired aboutNoMember's address line 2
MemberInformation.Citystring25City of the mailing address for the Member who was inquired aboutNoMember's city
MemberInformation.Statestring2Two-letter state code of the mailing address for the Member who was inquired aboutNoMember's state
MemberInformation.Zipstring9If exists, must be 5 or 9 digitsNoMember's ZIP code
MemberInformation.Phonestring10If exists, must be valid phone numberNoMember's phone number
MemberInformation.Emailstring256If exists, must match email formatNoMember's email address
MemberInformation.DateOfServiceBeginstringNAMust be in same Month/year as End; must be a valid dateYesStart date of service period
MemberInformation.DateOfServiceEndstringNAMust be in same Month/year as Begin; must be a valid dateNoEnd date of service period
MemberInformation.MemberIdstring255Unique identifier for the Member who was inquired aboutNoMember's unique ID

Response Details:

FieldTypeDescriptionShort Description
ErrorstringError message describing why the request could not be processed, if applicableError message, if any
ClientMemberCobMemberIdentity information for the Member who was inquired about, as matched by the systemMatched member identity
PoliciesCobPolicy (List)List of coverage/policy records identified for the MemberList of matched policies
IdentityMatchProbabilityScorestringConfidence score indicating how closely the matched identity aligns with the requestIdentity match confidence score
PrimacyScoreintScore used to determine the primacy/order-of-benefits rankingPrimacy ranking score
RequestIdstringEchoes the RequestId supplied on the requestEchoed correlation ID
ResponseIdguidUnique identifier generated for this responseUnique response ID
CustomCustomIn a "custom" object, listed as "propName": "value"Optional custom key/value data
ClientMember.Addr1stringFirst line of the mailing address for the MemberMember's address line 1
ClientMember.Addr2stringSecond line of the mailing address for the MemberMember's address line 2
ClientMember.CitystringCity of the Member's mailing addressMember's city
ClientMember.DobDateonlyDate of Birth of the MemberMember's date of birth
ClientMember.FirstNamestringFirst Name of the MemberMember's first name
ClientMember.GenderstringGender of the MemberMember's gender
ClientMember.LastNamestringLast Name of the MemberMember's last name
ClientMember.MiddleNamestringMiddle Name of the MemberMember's middle name
ClientMember.SSNstringSocial Security Number of the MemberMember's SSN
ClientMember.StatestringTwo-letter state code of the Member's mailing addressMember's state
ClientMember.ZipstringZIP code of the Member's mailing addressMember's zip
ClientMember.PhonestringPhone number of the MemberMember's phone number
ClientMember.EmailstringEmail address of the MemberMember's email address
Policies.BinstringBank Identification Number for the pharmacy benefit/carrierCarrier Bank ID Number
Policies.CarrierNamestringName of the insurance carrier providing coverageCarrier name
Policies.CoverageTypeTypeCode identifying the type of coverageCoverage type code
Policies.CoverageTypeDescstringDescription of the coverage typeCoverage type description
Policies.CoverageTypeGrpstringGroup/category the coverage type belongs toCoverage type group
Policies.OhiEffectiveDateDateOnlyDate the other health insurance (OHI) coverage became effectiveOHI effective date
Policies.OhiTerminationDateDateOnlyDate the other health insurance (OHI) coverage terminatedOHI termination date
Policies.GroupNamestringName of the employer/benefit group associated with the policyBenefit group name
Policies.GroupNumberstringNumber identifying the employer/benefit group associated with the policyBenefit group number
Policies.MemberCobMemberIdentity information for the covered Member on this policyCovered member identity
Policies.PolicyHolderCobMemberIdentity information for the policyholder of this policyPolicyholder identity
Policies.PcnstringProcessor Control Number used for pharmacy claims routingProcessor Control Number
Policies.PolicyIdstringUnique identifier for the policyPolicy ID
Policies.PolicyPersonCodestringCode identifying the covered person's role on the policyPolicy person code
Policies.RelationshipstringRelationship of the Member to the policyholderMember's relationship to policyholder
Policies.SubGroupNumberstringNumber identifying the sub-group associated with the policyBenefit sub-group number
Policies.OrderOfBenefitsintNumeric order used to determine primacy of benefitsBenefit order/primacy rank
Policies.PayerNamestringName of the payer responsible for the policyPayer name

Sample Request Object:

Note: The request below contains sample data for reference purposes only and does not represent actual values.

{
  "requestId": ":LookupTest",
  "consumerId": "4d823a55-27a4-4f2e-9c16-52d27b6f3f53",
  "clientId": "0d5a2074-552e-4679-98f8-0fd7d6703dcb",
  "memberInformation": {
    "firstName": "LOOKUP",
    "middleName": "",
    "lastName": "ENDPOINT",
    "dateOfBirth": "02/13/1937",
    "gender": "F",
    "ssn": "4445760282",
    "addressLineOne": "500 FAKE STREET",
    "addressLineTwo": "",
    "city": "PAYO",
    "state": "CA",
    "zip": "64712",
    "phone": "6456914364",
    "email": "[email protected]",
    "dateOfServiceBegin": "02/01/2025",
    "dateOfServiceEnd": "",
    "memberId": "12345",
    "memberPolicyId": "TS8048472"
  }
}

Sample Response Object:

Note: The response below contains sample data for reference purposes only and does not represent actual values.

{
	"correlationId": "2a45e463-d522-4bb8-86a4-f0b460488781",
	"error": "",
	"clientMember": {
		"addr1": "500 FAKE STREET",
		"addr2": "",
		"city": "PAYO",
		"dob": "1937-02-13",
		"firstName": "LOOKUP",
		"gender": "F",
		"lastName": "ENDPOINT",
		"middleName": "",
		"ssn": "4445760282",
		"state": "CA",
		"zip": "64712",
		"phone": "6456914364",
		"email": "[email protected]"
	},
	"policies": [
		{
			"bin": "",
			"carrierName": "DONOTTOUCH",
			"coverageType": "MM",
			"coverageTypeDesc": "MAJOR MEDICAL",
			"coverageTypeGrp": "M",
			"ohiEffectiveDate": "2025-01-01",
			"ohiTerminationDate": "2025-12-31",
			"groupName": "LOOKUPTEST",
			"groupNumber": "00067550B",
			"member": {
				"addr1": "500 FAKE STREET",
				"addr2": "",
				"city": "PAYO",
				"dob": "1937-02-13",
				"firstName": "LOOKUP",
				"gender": "F",
				"lastName": "ENDPOINT",
				"middleName": "",
				"ssn": "4445760282",
				"state": "CA",
				"zip": "64712",
				"phone": null,
				"email": null
			},
			"policyHolder": {
				"addr1": "500 FAKE STREET",
				"addr2": "",
				"city": "PAYO",
				"dob": "1932-02-13",
				"firstName": "URIAH",
				"gender": "M",
				"lastName": "DURHAM",
				"middleName": "",
				"ssn": "465435044",
				"state": "CA",
				"zip": "64712",
				"phone": null,
				"email": null
			},
			"pcn": "",
			"policyId": "TS8048472",
			"policyPersonCode": null,
			"relationship": "01",
			"subGroupNumber": "00007",
			"orderOfBenefits": 1,
			"payerName": "SCMICROSYSTEMS INC"
		},
		{
			"bin": "",
			"carrierName": "DONOTTOUCH",
			"coverageType": "MM",
			"coverageTypeDesc": "MAJOR MEDICAL",
			"coverageTypeGrp": "M",
			"ohiEffectiveDate": "2025-02-01",
			"ohiTerminationDate": "2025-12-31",
			"groupName": "LOOKUPTEST",
			"groupNumber": "00067550B",
			"member": {
				"addr1": "500 FAKE STREET",
				"addr2": "",
				"city": "PAYO",
				"dob": "1937-02-13",
				"firstName": "LOOKUP",
				"gender": "F",
				"lastName": "ENDPOINT",
				"middleName": "",
				"ssn": "4445760282",
				"state": "CA",
				"zip": "64712",
				"phone": null,
				"email": null
			},
			"policyHolder": {
				"addr1": "500 FAKE STREET",
				"addr2": "",
				"city": "PAYO",
				"dob": "1932-02-13",
				"firstName": "URIAH",
				"gender": "M",
				"lastName": "DURHAM",
				"middleName": "",
				"ssn": "465435044",
				"state": "CA",
				"zip": "64712",
				"phone": null,
				"email": null
			},
			"pcn": "",
			"policyId": "TS8048472",
			"policyPersonCode": null,
			"relationship": "01",
			"subGroupNumber": "00007",
			"orderOfBenefits": 2,
			"payerName": "SCMICROSYSTEMS INC"
		}
	],
	"identityMatchProbabilityScore": "1.00",
	"primacyScore": 100,
	"requestId": "LookupTest",
	"responseId": "7dd82aa7-1b8d-4336-acff-d51e76bba7c0",
	"custom": {}
}

PayOrDeny Endpoint

Workflow:

The diagram provides a high-level overview of the PayOrDeny processing flow. A customer or business user initiates a request either in real-time through the API Endpoint for immediate processing, or in bulk via a Queue when handling high volumes of requests. Regardless of the submission path, the system validates the member's eligibility and determines their primary coverage by cross-referencing account details and member information. Based on the outcome, the request is either Pay or Deny, and the corresponding claim decision is returned to the requester.

Request Details:

FieldTypeLengthDescriptionRequiredShort Description
RequestIdstring50Correlation identifier that the requestor provides, returned in responseYesCaller-supplied correlation ID
ClientIdstring (guid)NAmust be in guid formatYesClient GUID
ConsumerIdstring (guid)NAmust be in guid formatYesConsumer GUID
MemberInformationCobMember50Container holding the details of the Member who was inquired aboutYesMember detail object
MemberInformation.FirstNamestring128First Name of Member who was inquired aboutYesMember's first name
MemberInformation.MiddleNamestring128Middle Name of Member who was inquired aboutNoMember's middle name
MemberInformation.LastNamestring128Last Name of Member who was inquired aboutYesMember's last name
MemberInformation.DateOfBirthstringNADate of Birth of Member who was inquired about; must be a valid dateYesMember's date of birth
MemberInformation.Genderstring1Gender of Member who was inquired aboutNoMember's gender
MemberInformation.SSNstring9If exists, must be 9 digitsNoMember's Social Security Number
MemberInformation.AddressLineOnestring50First line of the mailing address for the Member who was inquired aboutNoMember's address line 1
MemberInformation.AddressLineTwostring50Second line of the mailing address for the Member who was inquired aboutNoMember's address line 2
MemberInformation.Citystring25City of the mailing address for the Member who was inquired aboutNoMember's city
MemberInformation.Statestring2Two-letter state code of the mailing address for the Member who was inquired aboutNoMember's state
MemberInformation.Zipstring9If exists, must be 5 or 9 digitsNoMember's ZIP code
MemberInformation.Phonestring10If exists, must be valid phone numberNoMember's phone number
MemberInformation.Emailstring256If exists, must match email formatNoMember's email address
MemberInformation.DateOfServiceBeginstringNAMust be in same Month/year as End; must be a valid dateYesStart date of service period
MemberInformation.DateOfServiceEndstringNAMust be in same Month/year as Begin; must be a valid dateNoEnd date of service period
MemberInformation.MemberIdstring255Unique identifier for the Member who was inquired aboutYesMember's unique ID
MemberInformation.MemberPolicyIdstring255Unique identifier for the Member's policy who was inquired aboutYesMember's policy ID

Response Details:

FieldTypeDescriptionShort Description
ErrorstringError message describing why the request could not be processed, if applicableError message, if any
RequestIdstringEchoes the RequestId supplied on the requestEchoed correlation ID
ResponseIdstringUnique identifier generated for this responseUnique response ID
PayIndicatorbooleanIndicates whether the claim should be paid (true) or denied (false)Pay/deny flag
MemberPolicyInformationPolicy Information (single object)Policy details used to determine the pay/deny outcomeMatched policy details
memberPolicyInformation.BinstringBank Identification Number for the pharmacy benefit/carrierCarrier Bank ID Number
memberPolicyInformation.CarrierNamestringName of the insurance carrier providing coverageCarrier name
memberPolicyInformation.CoverageTypeTypeCode identifying the type of coverageCoverage type code
memberPolicyInformation.CoverageTypeDescstringDescription of the coverage typeCoverage type description
memberPolicyInformation.CoverageTypeGrpstringGroup/category the coverage type belongs toCoverage type group
memberPolicyInformation.GroupNamestringName of the employer/benefit group associated with the policyBenefit group name
memberPolicyInformation.GroupNumberstringNumber identifying the employer/benefit group associated with the policyBenefit group number
memberPolicyInformation.OhiEffectiveDateDateOnlyDate the other health insurance (OHI) coverage became effectiveOHI effective date
memberPolicyInformation.OhiTerminationDateDateOnlyDate the other health insurance (OHI) coverage terminatedOHI termination date
memberPolicyInformation.OrderOfBenefitsintNumeric order used to determine primacy of benefitsBenefit order/primacy rank
memberPolicyInformation.PayerNamestringName of the payer responsible for the policyPayer name
memberPolicyInformation.PcnstringProcessor Control Number used for pharmacy claims routingProcessor Control Number
memberPolicyInformation.PolicyHolderFirstNamestringFirst Name of the policyholder for this policyPolicyholder's first name
memberPolicyInformation.PolicyHolderMiddleNamestringMiddle Name of the policyholder for this policyPolicyholder's middle name
memberPolicyInformation.PolicyHolderLastNamestringLast Name of the policyholder for this policyPolicyholder's last name
memberPolicyInformation.PolicyIdstringUnique identifier for the policyPolicy ID
memberPolicyInformation.PolicyPersonCodestringCode identifying the covered person's role on the policyPolicy person code
memberPolicyInformation.RelationshipstringRelationship of the Member to the policyholderMember's relationship to policyholder
memberPolicyInformation.SubGroupNumberstringNumber identifying the sub-group associated with the policyBenefit sub-group number

Sample Request Object:

Note: The request below contains sample data for reference purposes only and does not represent actual values

{
  "requestId": "PayOrDenyTest",
  "consumerId": "89fe25we-345a-4wrf-8131-a8fec3ma7a82",
  "clientId": "24eda4e2-9145-129e-910d-8we5a7816efc",
  "memberInformation": {
    "firstName": "PAY",
    "middleName": "",
    "lastName": "DENY",
    "dateOfBirth": "07/27/2026",
    "gender": "M",
    "ssn": "457843681",
    "addressLineOne": "DENY STREET",
    "addressLineTwo": "",
    "city": "PAYUP ANGELES",
    "state": "TN",
    "zip": "45010",
    "phone": "",
    "email": "",
    "dateOfServiceBegin": "02/20/2029",
    "dateOfServiceEnd": "",
    "memberId": "PK9456675",
		"memberPolicyId": "PK9456675"
  }
}

Sample Response Object:

Note: The response below contains sample data for reference purposes only and does not represent actual values

{
	"correlationId": "21780011-035b-46b0-bcc4-f77503cf5a66",
	"error": "",
	"requestId": "PayOrDenyTest",
	"responseId": "7d1e1c3a-09d4-454b-99e9-2caeaefe8328",
	"payIndicator": true,
	"memberPolicyInformation": {
		"bin": "",
		"carrierName": "DONOTTOUCH",
		"coverageType": "MM",
		"coverageTypeDesc": "MAJOR MEDICAL",
		"coverageTypeGrp": "M",
		"groupName": "PAYRAMUS",
		"groupNumber": "00000024V",
		"ohiEffectiveDate": "2021-06-27",
		"ohiTerminationDate": "2029-03-25",
		"orderOfBenefits": 1,
		"payerName": "PAYCHIP",
		"pcn": "",
		"policyHolderFirstName": "PAY",
		"policyHolderMiddleName": "",
		"policyHolderLastName": "DENY",
		"policyId": "PK9456675",
		"policyPersonCode": null,
		"relationship": "18",
		"subGroupNumber": "00054"
	}
}

How to Try an API?

Refer to the Getting Started section on how to use an API.
Release notes
View our Release notes for more information on the API