Partners and Connections

Note Access to this section is based on the type of your subscription. If you do not have access permissions, contact a CAQH administrator.

The CAQH Endpoint Directory facilitates communication between organizations to enable access to applications and endpoints published to the Directory by different organizations. To start communication with another organization and exchange credentials for the endpoints or applications to connect with your partners on their servers, you should send a connection request to this organization.

Note Only account administrators and superusers can send a connection request to another organization. If you do not have access permissions, contact your account administrator.

To send a connection request:

  1. Go to the Directory and click Organizations.
  2. Select the organization with which you want to establish a connection and exchange credentials, and then click Send Connection Request.
  3. In the Send Connection Request dialog, in Select Your Application or Endpoint, from the drop-down list, select the application or the endpoint as a source, and then, next to the field, from the drop-down list, select the application or the endpoint from your directory that you want to connect with your partner's application or endpoint. Scopes (permissions) are fetched from the application's Application Information and displayed in a certain connection request's details after you save the connection request. If you have selected the endpoint as a source, then, in Redirect URL, enter the redirect URL of the endpoint, and in Scopes, enter permissions for the endpoint.
  4. In To, the organization for which you want to send the connection request is selected automatically.
  5. In Select Partner's Application or Endpoint, from the drop-drown list, select the partner's application or endpoint as a target, and then, next to the field, from the drop-down list, select the application or the endpoint from the partner's directory to which you want to connect.
  6. In Environment, select the environment (blank, Sandbox, Production) for which the credentials are requested of the specified target partner.
  7. Enter the message that reflects the purpose of the partnership you want to establish, and then click Send. The target organization will receive a notification about the connection request.

    After you have filled in all the required information and sent the connection request, the CAQH Endpoint Directory system creates and registers an application for the specified source (application/endpoint) in a target partner's Developer Portal.

    Note Source endpoints are also created and registered as applications in the Developer Portal.

    If the Endpoint Directory system successfully identifies the target partner's Developer Portal based on partner's organization profile, then you can sign in to that portal as a developer.

    Once the target payer issues the client ID and the secret key in the Developer Portal for the source application/endpoint, the CAQH Endpoint Directory auto-approves a certain connection request and the status of the connection request is replaced from Awaiting Response to Accepted.

    You can view the credentials of the source-traget only after your partner issues them against a specific connection request. If the credentials are assigned, the CAQH Endpoint Directory fetches the most recent Client ID and the secret key from the target partner's Developer Portal that you can copy from Client ID & Secret Key on the Partners & Connections page.

    Note Only EPD administrators can view the credentials.

Note You cannot send a connection request to the organizations that have not published applications or endpoints to the CAQH Endpoint Directory.

With the Partners and Connections page, you can:

  • Accept or decline invitations from other organizations.
  • View a list of incoming and outgoing connection requests.
  • View the total number of connection requests and the number of connection requests of a certain status, such as: Accepted, Pending Action, Declined, Awaiting Response.
  • View the details of each connection request (the target organization name, the source application/endpoint for which the connection is requested, the target partner's application/endpoint to which the connection is requested, the date when the connection request has been sent, the client ID and the secret key if you are an EPD administrator).
  • Filter connection requests based on their status.
  • Sort connection requests by the table headers: Status, Organization Name, Your Application/Endpoint, Partner's Application/Endpoint, Modified On, and Client ID & Secret Key in the ascending or descending order.
  • Search for connection requests (using an organization name or a purpose of the request).
  • View the organization details using the link from a connection request.

Also, you can:

  • Select a specific connection request to view its details (the name of the organization to/from which this connection request has been sent/received, the dates when the connection request was sent/received/replied on, its status, comments when the connection request is accepted/rejected, scopes, the client ID and the secret key, the source application/endpoint for which the connection is requested, the target partner's application/endpoint to which the connection is requested, the environment for which the request was sent/received, the purpose of each connection request indicated by a certain payer).
  • View if the credentials are present in the Developer Portal.

    Note Only EPD administrators can view if the credentials are present in the Developer Portal.

  • View details on published applications and endpoints of the organization that has received a connection request from you or has sent a request to your organization.