Skip to content
/Provider API

Verato Provider API (2026.1.2)

Verato Provider Link services for managing provider identities (Practitioner Type 1, Health Facility Type 2, and Organizations), including:

  • Creating and updating master identities
  • Searching and querying by demographics, source/native IDs, and link IDs
  • Managing source lifecycle (soft delete, restore, hard delete)
  • Managing merge, unmerge, link, unlink workflows
  • Managing graph relationships between Verato entities
  • Retrieving identity-related notifications
Download OpenAPI description
provider.openapi.json
provider.openapi.yaml
Languages
Servers
Mock server
https://developer.verato.com/_mock/apis/provider.openapi
Production Provider Link API
https://api.verato.com/provider-link-ws/svc
Sandbox Provider Link API
https://sandbox.api.verato.com/provider-link-ws/svc

Add an Identity to the LINK stack

Request

Adds a new provider identity into the Verato LINK database. The posted identity may represent a Practitioner (Type 1), Health Facility (Type 2), or Organization. The service returns the resolved LINK identity, including linkId and domains, along with optional grouped-by-source and custom views.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(PostIdentityWsRequest)

Adds a new identity to the LINK database.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/postIdentity \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "identity": {
        "Practitioner (Type 1)": {
          "names": [
            {
              "use": "string",
              "prefix": "string",
              "first": "string",
              "middle": "string",
              "last": "string",
              "suffix": "string",
              "credential": "string"
            }
          ],
          "datesOfBirth": [
            {
              "dateOfBirth": "2019-08-24"
            }
          ],
          "genders": [
            {
              "gender": "string"
            }
          ],
          "genderIdentities": [
            {
              "genderIdentity": "string"
            }
          ],
          "contactInformation": [
            {
              "address": {
                "addressName": "string",
                "addressType": "string",
                "line1": "string",
                "line2": "string",
                "city": "string",
                "district": "string",
                "state": "string",
                "postalCode": "string",
                "country": "string",
                "latitude": 0,
                "longitude": 0,
                "validFrom": "2019-08-24",
                "validTo": "2019-08-24"
              },
              "phoneList": [
                {}
              ],
              "faxList": [
                {}
              ],
              "bestTimeToContact": [
                {}
              ]
            }
          ],
          "addresses": [
            {
              "addressName": "string",
              "addressType": "string",
              "line1": "string",
              "line2": "string",
              "city": "string",
              "district": "string",
              "state": "string",
              "postalCode": "string",
              "country": "string",
              "latitude": 0,
              "longitude": 0,
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "phoneNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "faxNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "emails": [
            {
              "email": "user@example.com",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "npis": [
            {
              "npi": "string",
              "entityTypeCode": "string",
              "deactivationDate": "2019-08-24"
            }
          ],
          "license": [
            {
              "number": "string",
              "state": "string",
              "taxonomyCode": "string",
              "licenseEffectiveDate": "2019-08-24",
              "licenseExpirationDate": "2019-08-24",
              "licenseStatus": "string",
              "licenseStatusDetail": "string",
              "licenseProfessionCode": "string",
              "licenseProfessionRankCode": "string",
              "licenseLastUpdateDate": "2019-08-24",
              "licenseProfessionDescription": "string",
              "licenseType": "string",
              "licensePrimary": "string"
            }
          ],
          "specialties": [
            {
              "specialtyTaxonomyCode": "string"
            }
          ],
          "communicationLanguages": [
            {
              "language": "string",
              "preferred": true
            }
          ],
          "practitionerRoles": [
            {
              "acceptingNewPatients": true,
              "serviceMode": "string",
              "clinicalExpertise": [
                {}
              ],
              "program": [
                {}
              ],
              "specialty": [
                {}
              ],
              "subSpecialty": [
                {}
              ],
              "availability": [
                {}
              ],
              "acceptedInsurances": [
                {}
              ]
            }
          ],
          "qualifications": [
            {
              "type": "string",
              "qualification": "string",
              "status": "string",
              "issuer": "string",
              "issueDate": "2019-08-24",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "alternateIdentifiers": [
            {
              "description": "string",
              "type": "string",
              "value": "string",
              "status": true,
              "issuer": "string",
              "issueDate": "2019-08-24",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "externalUniqueIdentifier": [
            {
              "issuer": "string",
              "value": "string",
              "status": "string",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "multipleBirthIndicator": [
            {
              "multipleBirthIndicator": true,
              "multipleBirthInteger": 0,
              "birthPlurality": 0
            }
          ],
          "ssns": [
            {
              "ssn": "string"
            }
          ],
          "citizenships": [
            {
              "citizenship": "string"
            }
          ],
          "photos": [
            {
              "url": "string"
            }
          ],
          "sexualOrientations": [
            {
              "sexualOrientation": "string"
            }
          ],
          "races": [
            {
              "race": "string"
            }
          ],
          "ethnicities": [
            {
              "ethnicity": "string"
            }
          ],
          "religiousAffiliations": [
            {
              "religiousAffiliation": "string"
            }
          ],
          "maritalStatuses": [
            {
              "maritalStatus": "string"
            }
          ],
          "deathDetails": [
            {
              "deceased": "string",
              "dateOfDeath": "2019-08-24",
              "city": "string",
              "county": "string",
              "state": "string",
              "country": "string"
            }
          ],
          "consents": [
            {
              "name": "string",
              "type": "string",
              "status": "string",
              "isRequired": true,
              "decision": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24",
              "source": "string",
              "regulatoryBasis": "string"
            }
          ],
          "preferences": [
            {
              "name": "string",
              "type": "string",
              "channels": [
                {}
              ]
            }
          ],
          "medicareInfo": [
            {
              "inPecos": true,
              "acceptsMedicare": true
            }
          ],
          "disciplinaryInfo": [
            {
              "warning": true,
              "exclusionType": "string"
            }
          ],
          "locationInfo": [
            {
              "ruralUrbanSuburban": "string",
              "coloCode": "string"
            }
          ],
          "education": [
            {
              "medSchool": "string",
              "gradYear": 0
            }
          ],
          "practiceInfo": [
            {
              "estimatedPracticeYears": 0
            }
          ],
          "research": [
            {
              "areasOfInterest": "string",
              "publications": "string"
            }
          ]
        },
        "Health Facility (Type 2)": {
          "organizationNames": [
            {
              "legalBusinessName": "string",
              "otherOrgName": "string",
              "tradingName": "string",
              "parentOrgName": "string"
            }
          ],
          "contactInformation": [
            {
              "address": {
                "addressName": "string",
                "addressType": "string",
                "line1": "string",
                "line2": "string",
                "city": "string",
                "district": "string",
                "state": "string",
                "postalCode": "string",
                "country": "string",
                "latitude": 0,
                "longitude": 0,
                "validFrom": "2019-08-24",
                "validTo": "2019-08-24"
              },
              "phoneList": [
                {}
              ],
              "faxList": [
                {}
              ],
              "bestTimeToContact": [
                {}
              ]
            }
          ],
          "addresses": [
            {
              "addressName": "string",
              "addressType": "string",
              "line1": "string",
              "line2": "string",
              "city": "string",
              "district": "string",
              "state": "string",
              "postalCode": "string",
              "country": "string",
              "latitude": 0,
              "longitude": 0,
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "phoneNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "faxNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "emails": [
            {
              "email": "user@example.com",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "npis": [
            {
              "npi": "string",
              "entityTypeCode": "string",
              "deactivationDate": "2019-08-24"
            }
          ],
          "license": [
            {
              "number": "string",
              "state": "string",
              "taxonomyCode": "string",
              "licenseEffectiveDate": "2019-08-24",
              "licenseExpirationDate": "2019-08-24",
              "licenseStatus": "string",
              "licenseStatusDetail": "string",
              "licenseProfessionCode": "string",
              "licenseProfessionRankCode": "string",
              "licenseLastUpdateDate": "2019-08-24",
              "licenseProfessionDescription": "string",
              "licenseType": "string",
              "licensePrimary": "string"
            }
          ],
          "specialties": [
            {
              "specialtyTaxonomyCode": "string"
            }
          ],
          "alternateIdentifiers": [
            {
              "description": "string",
              "type": "string",
              "value": "string",
              "status": true,
              "issuer": "string",
              "issueDate": "2019-08-24",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "externalUniqueIdentifier": [
            {
              "issuer": "string",
              "value": "string",
              "status": "string",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "groupTaxonomies": [
            {
              "groupTaxonomyCode": "string"
            }
          ],
          "authorizedOfficials": [
            {
              "title": "string",
              "prefix": "string",
              "first": "string",
              "middle": "string",
              "last": "string",
              "suffix": "string",
              "credential": "string",
              "phoneNumber": "string"
            }
          ],
          "employerIdentificationNumber": [
            {
              "value": "string",
              "status": true,
              "issuer": "string",
              "issueDate": "2019-08-24",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "naicsClassifications": [
            {
              "sector": "string",
              "subSector": "string",
              "industryGroup": "string",
              "industry": "string",
              "nationalIndustry": "string"
            }
          ],
          "sicClassifications": [
            {
              "code": "string"
            }
          ],
          "qualifications": [
            {
              "type": "string",
              "qualification": "string",
              "status": "string",
              "issuer": "string",
              "issueDate": "2019-08-24",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "types": [
            {
              "type": "string",
              "subType": "string"
            }
          ],
          "contactOther": [
            {
              "system": "string",
              "type": "string",
              "value": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "product": [
            {
              "name": "string",
              "code": "string",
              "type": "string",
              "category": "string",
              "price": 0,
              "status": "string",
              "description": "string",
              "launchDate": "2019-08-24",
              "market": "string",
              "lineOfBusiness": "string",
              "serviceLines": [
                {}
              ]
            }
          ],
          "numberOfEmployees": [
            {
              "numberOfEmployees": 0
            }
          ],
          "foundedDate": [
            {
              "foundedDate": "2019-08-24"
            }
          ],
          "annualRevenue": [
            {
              "annualRevenue": 0,
              "year": 0
            }
          ],
          "legalStatus": [
            {
              "type": "string",
              "source": "string",
              "effectiveDate": "2019-08-24",
              "verificationDate": "2019-08-24",
              "jurisdiction": "string",
              "registrationCountry": "string"
            }
          ],
          "acceptedInsurances": [
            {
              "payerName": "string",
              "status": "string",
              "insuranceType": "string",
              "planId": "string",
              "planType": "string",
              "networkStatus": "string",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ]
        }
      },
      "responseIdentityFormatNames": [
        "string"
      ]
    }
  }'

Responses

PostIdentity service response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(PostIdentityWsResponse)

PostIdentity response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "identityGroupedBySource": [ … ],
    "customerSources": [ … ],
    "linkIdentity": { … },
    "linkId": "string",
    "identity": { … },
    "domains": [ … ],
    "customizedIdentities": { … },
    "events": [ … ],
    "incomingIdentity": { … }
  }
}

Search using demographic information

Request

Performs a multi-match search across the LINK database using demographic and provider attributes. Returns a ranked list of candidate matches with match scores and same-identity indicators.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(DemographicsSearchWsRequest)

Request for demographics-based search (multi-match).

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/demographicsSearch \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "identity": {
        "Practitioner (Type 1)": {
          "names": [
            {
              "use": "string",
              "prefix": "string",
              "first": "string",
              "middle": "string",
              "last": "string",
              "suffix": "string",
              "credential": "string"
            }
          ],
          "datesOfBirth": [
            {
              "dateOfBirth": "2019-08-24"
            }
          ],
          "genders": [
            {
              "gender": "string"
            }
          ],
          "genderIdentities": [
            {
              "genderIdentity": "string"
            }
          ],
          "contactInformation": [
            {
              "address": {
                "addressName": "string",
                "addressType": "string",
                "line1": "string",
                "line2": "string",
                "city": "string",
                "district": "string",
                "state": "string",
                "postalCode": "string",
                "country": "string",
                "latitude": 0,
                "longitude": 0,
                "validFrom": "2019-08-24",
                "validTo": "2019-08-24"
              },
              "phoneList": [
                {}
              ],
              "faxList": [
                {}
              ],
              "bestTimeToContact": [
                {}
              ]
            }
          ],
          "addresses": [
            {
              "addressName": "string",
              "addressType": "string",
              "line1": "string",
              "line2": "string",
              "city": "string",
              "district": "string",
              "state": "string",
              "postalCode": "string",
              "country": "string",
              "latitude": 0,
              "longitude": 0,
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "phoneNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "faxNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "emails": [
            {
              "email": "user@example.com",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "npis": [
            {
              "npi": "string",
              "entityTypeCode": "string",
              "deactivationDate": "2019-08-24"
            }
          ],
          "license": [
            {
              "number": "string",
              "state": "string",
              "taxonomyCode": "string",
              "licenseEffectiveDate": "2019-08-24",
              "licenseExpirationDate": "2019-08-24",
              "licenseStatus": "string",
              "licenseStatusDetail": "string",
              "licenseProfessionCode": "string",
              "licenseProfessionRankCode": "string",
              "licenseLastUpdateDate": "2019-08-24",
              "licenseProfessionDescription": "string",
              "licenseType": "string",
              "licensePrimary": "string"
            }
          ],
          "specialties": [
            {
              "specialtyTaxonomyCode": "string"
            }
          ],
          "communicationLanguages": [
            {
              "language": "string",
              "preferred": true
            }
          ],
          "practitionerRoles": [
            {
              "acceptingNewPatients": true,
              "serviceMode": "string",
              "clinicalExpertise": [
                {}
              ],
              "program": [
                {}
              ],
              "specialty": [
                {}
              ],
              "subSpecialty": [
                {}
              ],
              "availability": [
                {}
              ],
              "acceptedInsurances": [
                {}
              ]
            }
          ],
          "qualifications": [
            {
              "type": "string",
              "qualification": "string",
              "status": "string",
              "issuer": "string",
              "issueDate": "2019-08-24",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "alternateIdentifiers": [
            {
              "description": "string",
              "type": "string",
              "value": "string",
              "status": true,
              "issuer": "string",
              "issueDate": "2019-08-24",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "externalUniqueIdentifier": [
            {
              "issuer": "string",
              "value": "string",
              "status": "string",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "multipleBirthIndicator": [
            {
              "multipleBirthIndicator": true,
              "multipleBirthInteger": 0,
              "birthPlurality": 0
            }
          ],
          "ssns": [
            {
              "ssn": "string"
            }
          ],
          "citizenships": [
            {
              "citizenship": "string"
            }
          ],
          "photos": [
            {
              "url": "string"
            }
          ],
          "sexualOrientations": [
            {
              "sexualOrientation": "string"
            }
          ],
          "races": [
            {
              "race": "string"
            }
          ],
          "ethnicities": [
            {
              "ethnicity": "string"
            }
          ],
          "religiousAffiliations": [
            {
              "religiousAffiliation": "string"
            }
          ],
          "maritalStatuses": [
            {
              "maritalStatus": "string"
            }
          ],
          "deathDetails": [
            {
              "deceased": "string",
              "dateOfDeath": "2019-08-24",
              "city": "string",
              "county": "string",
              "state": "string",
              "country": "string"
            }
          ],
          "consents": [
            {
              "name": "string",
              "type": "string",
              "status": "string",
              "isRequired": true,
              "decision": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24",
              "source": "string",
              "regulatoryBasis": "string"
            }
          ],
          "preferences": [
            {
              "name": "string",
              "type": "string",
              "channels": [
                {}
              ]
            }
          ],
          "medicareInfo": [
            {
              "inPecos": true,
              "acceptsMedicare": true
            }
          ],
          "disciplinaryInfo": [
            {
              "warning": true,
              "exclusionType": "string"
            }
          ],
          "locationInfo": [
            {
              "ruralUrbanSuburban": "string",
              "coloCode": "string"
            }
          ],
          "education": [
            {
              "medSchool": "string",
              "gradYear": 0
            }
          ],
          "practiceInfo": [
            {
              "estimatedPracticeYears": 0
            }
          ],
          "research": [
            {
              "areasOfInterest": "string",
              "publications": "string"
            }
          ]
        },
        "Health Facility (Type 2)": {
          "organizationNames": [
            {
              "legalBusinessName": "string",
              "otherOrgName": "string",
              "tradingName": "string",
              "parentOrgName": "string"
            }
          ],
          "contactInformation": [
            {
              "address": {
                "addressName": "string",
                "addressType": "string",
                "line1": "string",
                "line2": "string",
                "city": "string",
                "district": "string",
                "state": "string",
                "postalCode": "string",
                "country": "string",
                "latitude": 0,
                "longitude": 0,
                "validFrom": "2019-08-24",
                "validTo": "2019-08-24"
              },
              "phoneList": [
                {}
              ],
              "faxList": [
                {}
              ],
              "bestTimeToContact": [
                {}
              ]
            }
          ],
          "addresses": [
            {
              "addressName": "string",
              "addressType": "string",
              "line1": "string",
              "line2": "string",
              "city": "string",
              "district": "string",
              "state": "string",
              "postalCode": "string",
              "country": "string",
              "latitude": 0,
              "longitude": 0,
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "phoneNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "faxNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "emails": [
            {
              "email": "user@example.com",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "npis": [
            {
              "npi": "string",
              "entityTypeCode": "string",
              "deactivationDate": "2019-08-24"
            }
          ],
          "license": [
            {
              "number": "string",
              "state": "string",
              "taxonomyCode": "string",
              "licenseEffectiveDate": "2019-08-24",
              "licenseExpirationDate": "2019-08-24",
              "licenseStatus": "string",
              "licenseStatusDetail": "string",
              "licenseProfessionCode": "string",
              "licenseProfessionRankCode": "string",
              "licenseLastUpdateDate": "2019-08-24",
              "licenseProfessionDescription": "string",
              "licenseType": "string",
              "licensePrimary": "string"
            }
          ],
          "specialties": [
            {
              "specialtyTaxonomyCode": "string"
            }
          ],
          "alternateIdentifiers": [
            {
              "description": "string",
              "type": "string",
              "value": "string",
              "status": true,
              "issuer": "string",
              "issueDate": "2019-08-24",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "externalUniqueIdentifier": [
            {
              "issuer": "string",
              "value": "string",
              "status": "string",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "groupTaxonomies": [
            {
              "groupTaxonomyCode": "string"
            }
          ],
          "authorizedOfficials": [
            {
              "title": "string",
              "prefix": "string",
              "first": "string",
              "middle": "string",
              "last": "string",
              "suffix": "string",
              "credential": "string",
              "phoneNumber": "string"
            }
          ],
          "employerIdentificationNumber": [
            {
              "value": "string",
              "status": true,
              "issuer": "string",
              "issueDate": "2019-08-24",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "naicsClassifications": [
            {
              "sector": "string",
              "subSector": "string",
              "industryGroup": "string",
              "industry": "string",
              "nationalIndustry": "string"
            }
          ],
          "sicClassifications": [
            {
              "code": "string"
            }
          ],
          "qualifications": [
            {
              "type": "string",
              "qualification": "string",
              "status": "string",
              "issuer": "string",
              "issueDate": "2019-08-24",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "types": [
            {
              "type": "string",
              "subType": "string"
            }
          ],
          "contactOther": [
            {
              "system": "string",
              "type": "string",
              "value": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "product": [
            {
              "name": "string",
              "code": "string",
              "type": "string",
              "category": "string",
              "price": 0,
              "status": "string",
              "description": "string",
              "launchDate": "2019-08-24",
              "market": "string",
              "lineOfBusiness": "string",
              "serviceLines": [
                {}
              ]
            }
          ],
          "numberOfEmployees": [
            {
              "numberOfEmployees": 0
            }
          ],
          "foundedDate": [
            {
              "foundedDate": "2019-08-24"
            }
          ],
          "annualRevenue": [
            {
              "annualRevenue": 0,
              "year": 0
            }
          ],
          "legalStatus": [
            {
              "type": "string",
              "source": "string",
              "effectiveDate": "2019-08-24",
              "verificationDate": "2019-08-24",
              "jurisdiction": "string",
              "registrationCountry": "string"
            }
          ],
          "acceptedInsurances": [
            {
              "payerName": "string",
              "status": "string",
              "insuranceType": "string",
              "planId": "string",
              "planType": "string",
              "networkStatus": "string",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ]
        }
      },
      "matchScoreThreshold": 0.1,
      "maxSearchResults": 1,
      "responseIdentityFormatNames": [
        "string"
      ]
    }
  }'

Responses

Demographics search response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(DemographicsSearchWsResponse)

Demographics search response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "searchResults": [ … ]
  }
}

Query using demographic information

Request

Performs a best-match query for a single identity using demographic and provider attributes. Returns the resolved identity, linkId, and domains, optionally with grouped-by-source and custom views.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(DemographicsQueryWsRequest)

Request for demographics-based query.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/demographicsQuery \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "identity": {
        "Practitioner (Type 1)": {
          "names": [
            {
              "use": "string",
              "prefix": "string",
              "first": "string",
              "middle": "string",
              "last": "string",
              "suffix": "string",
              "credential": "string"
            }
          ],
          "datesOfBirth": [
            {
              "dateOfBirth": "2019-08-24"
            }
          ],
          "genders": [
            {
              "gender": "string"
            }
          ],
          "genderIdentities": [
            {
              "genderIdentity": "string"
            }
          ],
          "contactInformation": [
            {
              "address": {
                "addressName": "string",
                "addressType": "string",
                "line1": "string",
                "line2": "string",
                "city": "string",
                "district": "string",
                "state": "string",
                "postalCode": "string",
                "country": "string",
                "latitude": 0,
                "longitude": 0,
                "validFrom": "2019-08-24",
                "validTo": "2019-08-24"
              },
              "phoneList": [
                {}
              ],
              "faxList": [
                {}
              ],
              "bestTimeToContact": [
                {}
              ]
            }
          ],
          "addresses": [
            {
              "addressName": "string",
              "addressType": "string",
              "line1": "string",
              "line2": "string",
              "city": "string",
              "district": "string",
              "state": "string",
              "postalCode": "string",
              "country": "string",
              "latitude": 0,
              "longitude": 0,
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "phoneNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "faxNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "emails": [
            {
              "email": "user@example.com",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "npis": [
            {
              "npi": "string",
              "entityTypeCode": "string",
              "deactivationDate": "2019-08-24"
            }
          ],
          "license": [
            {
              "number": "string",
              "state": "string",
              "taxonomyCode": "string",
              "licenseEffectiveDate": "2019-08-24",
              "licenseExpirationDate": "2019-08-24",
              "licenseStatus": "string",
              "licenseStatusDetail": "string",
              "licenseProfessionCode": "string",
              "licenseProfessionRankCode": "string",
              "licenseLastUpdateDate": "2019-08-24",
              "licenseProfessionDescription": "string",
              "licenseType": "string",
              "licensePrimary": "string"
            }
          ],
          "specialties": [
            {
              "specialtyTaxonomyCode": "string"
            }
          ],
          "communicationLanguages": [
            {
              "language": "string",
              "preferred": true
            }
          ],
          "practitionerRoles": [
            {
              "acceptingNewPatients": true,
              "serviceMode": "string",
              "clinicalExpertise": [
                {}
              ],
              "program": [
                {}
              ],
              "specialty": [
                {}
              ],
              "subSpecialty": [
                {}
              ],
              "availability": [
                {}
              ],
              "acceptedInsurances": [
                {}
              ]
            }
          ],
          "qualifications": [
            {
              "type": "string",
              "qualification": "string",
              "status": "string",
              "issuer": "string",
              "issueDate": "2019-08-24",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "alternateIdentifiers": [
            {
              "description": "string",
              "type": "string",
              "value": "string",
              "status": true,
              "issuer": "string",
              "issueDate": "2019-08-24",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "externalUniqueIdentifier": [
            {
              "issuer": "string",
              "value": "string",
              "status": "string",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "multipleBirthIndicator": [
            {
              "multipleBirthIndicator": true,
              "multipleBirthInteger": 0,
              "birthPlurality": 0
            }
          ],
          "ssns": [
            {
              "ssn": "string"
            }
          ],
          "citizenships": [
            {
              "citizenship": "string"
            }
          ],
          "photos": [
            {
              "url": "string"
            }
          ],
          "sexualOrientations": [
            {
              "sexualOrientation": "string"
            }
          ],
          "races": [
            {
              "race": "string"
            }
          ],
          "ethnicities": [
            {
              "ethnicity": "string"
            }
          ],
          "religiousAffiliations": [
            {
              "religiousAffiliation": "string"
            }
          ],
          "maritalStatuses": [
            {
              "maritalStatus": "string"
            }
          ],
          "deathDetails": [
            {
              "deceased": "string",
              "dateOfDeath": "2019-08-24",
              "city": "string",
              "county": "string",
              "state": "string",
              "country": "string"
            }
          ],
          "consents": [
            {
              "name": "string",
              "type": "string",
              "status": "string",
              "isRequired": true,
              "decision": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24",
              "source": "string",
              "regulatoryBasis": "string"
            }
          ],
          "preferences": [
            {
              "name": "string",
              "type": "string",
              "channels": [
                {}
              ]
            }
          ],
          "medicareInfo": [
            {
              "inPecos": true,
              "acceptsMedicare": true
            }
          ],
          "disciplinaryInfo": [
            {
              "warning": true,
              "exclusionType": "string"
            }
          ],
          "locationInfo": [
            {
              "ruralUrbanSuburban": "string",
              "coloCode": "string"
            }
          ],
          "education": [
            {
              "medSchool": "string",
              "gradYear": 0
            }
          ],
          "practiceInfo": [
            {
              "estimatedPracticeYears": 0
            }
          ],
          "research": [
            {
              "areasOfInterest": "string",
              "publications": "string"
            }
          ]
        },
        "Health Facility (Type 2)": {
          "organizationNames": [
            {
              "legalBusinessName": "string",
              "otherOrgName": "string",
              "tradingName": "string",
              "parentOrgName": "string"
            }
          ],
          "contactInformation": [
            {
              "address": {
                "addressName": "string",
                "addressType": "string",
                "line1": "string",
                "line2": "string",
                "city": "string",
                "district": "string",
                "state": "string",
                "postalCode": "string",
                "country": "string",
                "latitude": 0,
                "longitude": 0,
                "validFrom": "2019-08-24",
                "validTo": "2019-08-24"
              },
              "phoneList": [
                {}
              ],
              "faxList": [
                {}
              ],
              "bestTimeToContact": [
                {}
              ]
            }
          ],
          "addresses": [
            {
              "addressName": "string",
              "addressType": "string",
              "line1": "string",
              "line2": "string",
              "city": "string",
              "district": "string",
              "state": "string",
              "postalCode": "string",
              "country": "string",
              "latitude": 0,
              "longitude": 0,
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "phoneNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "faxNumbers": [
            {
              "number": "string",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "emails": [
            {
              "email": "user@example.com",
              "type": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "npis": [
            {
              "npi": "string",
              "entityTypeCode": "string",
              "deactivationDate": "2019-08-24"
            }
          ],
          "license": [
            {
              "number": "string",
              "state": "string",
              "taxonomyCode": "string",
              "licenseEffectiveDate": "2019-08-24",
              "licenseExpirationDate": "2019-08-24",
              "licenseStatus": "string",
              "licenseStatusDetail": "string",
              "licenseProfessionCode": "string",
              "licenseProfessionRankCode": "string",
              "licenseLastUpdateDate": "2019-08-24",
              "licenseProfessionDescription": "string",
              "licenseType": "string",
              "licensePrimary": "string"
            }
          ],
          "specialties": [
            {
              "specialtyTaxonomyCode": "string"
            }
          ],
          "alternateIdentifiers": [
            {
              "description": "string",
              "type": "string",
              "value": "string",
              "status": true,
              "issuer": "string",
              "issueDate": "2019-08-24",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "externalUniqueIdentifier": [
            {
              "issuer": "string",
              "value": "string",
              "status": "string",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ],
          "groupTaxonomies": [
            {
              "groupTaxonomyCode": "string"
            }
          ],
          "authorizedOfficials": [
            {
              "title": "string",
              "prefix": "string",
              "first": "string",
              "middle": "string",
              "last": "string",
              "suffix": "string",
              "credential": "string",
              "phoneNumber": "string"
            }
          ],
          "employerIdentificationNumber": [
            {
              "value": "string",
              "status": true,
              "issuer": "string",
              "issueDate": "2019-08-24",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "naicsClassifications": [
            {
              "sector": "string",
              "subSector": "string",
              "industryGroup": "string",
              "industry": "string",
              "nationalIndustry": "string"
            }
          ],
          "sicClassifications": [
            {
              "code": "string"
            }
          ],
          "qualifications": [
            {
              "type": "string",
              "qualification": "string",
              "status": "string",
              "issuer": "string",
              "issueDate": "2019-08-24",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "types": [
            {
              "type": "string",
              "subType": "string"
            }
          ],
          "contactOther": [
            {
              "system": "string",
              "type": "string",
              "value": "string",
              "validFrom": "2019-08-24",
              "validTo": "2019-08-24"
            }
          ],
          "product": [
            {
              "name": "string",
              "code": "string",
              "type": "string",
              "category": "string",
              "price": 0,
              "status": "string",
              "description": "string",
              "launchDate": "2019-08-24",
              "market": "string",
              "lineOfBusiness": "string",
              "serviceLines": [
                {}
              ]
            }
          ],
          "numberOfEmployees": [
            {
              "numberOfEmployees": 0
            }
          ],
          "foundedDate": [
            {
              "foundedDate": "2019-08-24"
            }
          ],
          "annualRevenue": [
            {
              "annualRevenue": 0,
              "year": 0
            }
          ],
          "legalStatus": [
            {
              "type": "string",
              "source": "string",
              "effectiveDate": "2019-08-24",
              "verificationDate": "2019-08-24",
              "jurisdiction": "string",
              "registrationCountry": "string"
            }
          ],
          "acceptedInsurances": [
            {
              "payerName": "string",
              "status": "string",
              "insuranceType": "string",
              "planId": "string",
              "planType": "string",
              "networkStatus": "string",
              "startDate": "2019-08-24",
              "endDate": "2019-08-24"
            }
          ]
        }
      },
      "responseIdentityFormatNames": [
        "string"
      ]
    }
  }'

Responses

Demographics query response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(DemographicsQueryWsResponse)

Demographics query response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "identityGroupedBySource": [ … ],
    "customerSources": [ … ],
    "linkId": "string",
    "identity": { … },
    "domains": [ … ],
    "customizedIdentities": { … }
  }
}

Query using native ID

Request

Queries the LINK database for an identity using a source + nativeId pair. Use this when you know the source system identifier and want to retrieve the Verato LINK identity.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(NativeIdQueryWsRequest)

Query using source information.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/nativeIdQuery \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "source": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      },
      "responseIdentityFormatNames": [
        "string"
      ]
    }
  }'

Responses

Native ID query response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(NativeIdQueryWsResponse)

Source-based query response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "identityGroupedBySource": [ … ],
    "customerSources": [ … ],
    "linkId": "string",
    "identity": { … },
    "domains": [ … ],
    "customizedIdentities": { … }
  }
}

Query using LINK ID

Request

Queries the LINK database for an identity using the Verato LINK ID. This is the primary way to retrieve an identity when you already have the linkId from a previous operation.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(IdentityIdQueryWsRequest)

Query by linkId.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/identityIdQuery \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "linkId": "string",
      "responseIdentityFormatNames": [
        "string"
      ]
    }
  }'

Responses

Identity by linkId response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(IdentityIdQueryWsResponse)

Identity-by-linkId response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "identityGroupedBySource": [ … ],
    "customerSources": [ … ],
    "linkId": "string",
    "identity": { … },
    "domains": [ … ],
    "requestedLinkId": "string",
    "customizedIdentities": { … }
  }
}

Hard delete a source identity

Request

Permanently removes all information and history associated with a specific source + nativeId across the LINK database. This also removes merge/unmerge history associated with that source identity. Use with caution.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(DeleteSourceIdentityWsRequest)

Hard delete all information associated with a source.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/deleteSourceIdentity \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "source": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      }
    }
  }'

Responses

Hard delete source response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(DeleteSourceIdentityWsResponse)

Hard delete source response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "linkIdsModified": [ … ],
    "linkIdsDeleted": [ … ]
  }
}

Soft delete a source from identities

Request

Soft deletes a source from all identities that reference it. The source and its data are marked as deleted but can be restored later. Merge and linkage history is preserved for audit.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(SoftDeleteSourceWsRequest)

Soft-delete a source across all matching entities.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/softDeleteSource \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "sourceToSoftDelete": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      }
    }
  }'

Responses

Soft delete source response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(SoftDeleteSourceWsResponse)

Soft delete source response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "linkIdsSoftDeleted": [ … ],
    "linkIdsModified": [ … ]
  }
}

Restore a soft-deleted source

Request

Restores a previously soft-deleted source across all identities where it was present. A new entity may be created or existing entities modified depending on the current state of the graph.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject

TODO – RestoreSourceWsRequest wrapper (see legacy swagger).

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/restoreSource \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {}
  }'

Responses

Restore source response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(RestoreSourceWsResponse)

Restore source response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "linkIdsModified": [ … ],
    "linkIdCreated": "string"
  }
}

Merge two identities

Request

Merges a "toRetire" source identity into a "toSurvive" source identity. After a merge, the retired source is marked as merged and the surviving identity contains combined data. The response returns the surviving linkId.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(MergeIdentitiesWsRequest)

Merge (retire) data from one source into another.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/mergeIdentities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "toSurviveSource": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      },
      "toRetireSource": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      }
    }
  }'

Responses

Merge identities response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(MergeIdentitiesWsResponse)

Merge identities response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "linkId": "string",
    "toSurviveSource": { … }
  }
}

Unmerge two identities

Request

Reverses a previous merge operation by extracting a previously merged source identity into its own record. Returns the new linkId and the linkId it was unmerged from.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(UnmergeIdentitiesWsRequest)

Unmerge a previously merged source into a new identity.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/unmergeIdentities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "unmergeFromSource": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      },
      "unmergeSource": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      }
    }
  }'

Responses

Unmerge identities response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(UnmergeIdentitiesWsResponse)

Unmerge identities response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "unmergedSource": { … },
    "unmergedFromSource": { … },
    "unmergedId": "string",
    "unmergedFromId": "string"
  }
}

Link two identities

Request

Links two existing identities together without retiring either source. This is typically used when you determine that two separate source identities belong to the same real-world provider, and they should be represented as a single Verato identity cluster.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(LinkIdentitiesWsRequest)

Link two identities together.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/linkIdentities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "linkToSource": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      },
      "source": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      }
    }
  }'

Responses

Link identities response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(LinkIdentitiesWsResponse)

Link identities response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "linkId": "string",
    "linkToSource": { … }
  }
}

Unlink two identities

Request

Splits two previously linked identities into separate identity clusters. The operation uses the provided source information to determine which source identity should be extracted into a new linkId.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(UnlinkIdentitiesWsRequest)

Unlink data from one identity to create another.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/unlinkIdentities \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "unlinkFromSource": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      },
      "source": {
        "date": "2019-08-24",
        "name": "string",
        "id": "string"
      }
    }
  }'

Responses

Unlink identities response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(UnlinkIdentitiesWsResponse)

Unlink identities response content.

Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "unlinkedId": "string",
    "unlinkedSource": { … },
    "unlinkedFromId": "string",
    "unlinkedFromSource": { … }
  }
}

Add a new relationship

Request

Adds a new relationship between two Verato entities (e.g., practitioner to facility, facility to organization) according to the configured relationship definitions and verbs.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(AddRelationshipWsRequest)
curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/addRelationshipService \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "relationship": {
        "id": "string",
        "relationshipVerb": "string",
        "inverseRelationshipVerb": "string",
        "subjectVeratoId": "string",
        "objectVeratoId": "string",
        "domain": "string",
        "status": "string",
        "trustFactor": "string",
        "startDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z",
        "details": {
          "property1": null,
          "property2": null
        }
      }
    }
  }'

Responses

Add relationship response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(AddRelationshipWsResponse)
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "relationship": { … }
  }
}

Delete a relationship

Request

Deletes an existing relationship between two entities. The relationship is identified by its relationship ID.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(DeleteRelationshipWsRequest)
curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/deleteRelationshipService \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "id": "string"
    }
  }'

Responses

Delete relationship response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(DeleteRelationshipWsResponse)
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "id": "string"
  }
}

Update/search an existing relationship

Request

Searches for and/or updates an existing relationship. Typically used to modify attributes or status on a relationship between two entities.

Security
bearerAuth
Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(UpdateRelationshipWsRequest)
curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/searchRelationshipsService \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "relationship": {
        "id": "string",
        "relationshipVerb": "string",
        "inverseRelationshipVerb": "string",
        "subjectVeratoId": "string",
        "objectVeratoId": "string",
        "domain": "string",
        "status": "string",
        "trustFactor": "string",
        "startDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z",
        "details": {
          "property1": null,
          "property2": null
        }
      }
    }
  }'

Responses

Search/update relationship response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(UpdateRelationshipWsResponse)
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "relationship": { … }
  }
}

Query notifications

Request

Retrieves identity-related notifications for a specific period of time, such as merge events, link/unlink events, or other configured notifications. Results are paginated by pageNumber and pageSize.

Security
bearerAuth
Bodyapplication/jsonrequired
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

auditLogMapobject(StringMap)

Map of string keys to string values.

trackingIdstring

Optional client-defined correlation ID.

contentobject(SearchNotificationsWsRequest)

Query notifications for the customer.

curl -i -X POST \
  https://developer.verato.com/_mock/apis/provider.openapi/searchNotifications \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "auditId": "string",
    "auditLogMap": {
      "property1": "string",
      "property2": "string"
    },
    "trackingId": "string",
    "content": {
      "pageNumber": 0,
      "pageSize": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z"
    }
  }'

Responses

Notifications search response

Bodyapplication/json
auditIdstring(AuditID)

Unique audit identifier for correlating requests and responses.

successboolean

Indicates whether the business operation succeeded.

unparsedJsonstring

Raw response payload, for debugging or migration.

warningsArray of strings

Non-fatal warnings generated by the operation.

retryableErrorboolean

Indicates whether an error is transient and the request may be retried.

messagestring

Human-readable status message.

errorsArray of strings

Error messages if success is false.

trackingIdstring

Echo of the request trackingId, if provided.

contentobject(SearchNotificationsWsResponse)
Response
application/json
{
  "auditId": "string",
  "success": true,
  "unparsedJson": "string",
  "warnings": [
    "string"
  ],
  "retryableError": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "trackingId": "string",
  "content": {
    "customerId": "string",
    "hasNext": true,
    "notifications": [ … ],
    "totalElements": 0
  }
}