Getting Started with the Axuall API

What is the Axuall API?

The Axuall API is built to allow our clients and partners to access the most recent, verified copy of a practitioner's data. Loading all existing clinicians into Axuall enables:

1. Actualization of data on file
2. Ensure organization always have the latest information on clinicians
3. Ongoing monitoring of clinicians

Request Methods

The Axuall API endpoints use two request methods - GET and POST.

A POST request is a way for our clients to send data to Axuall. A GET request is a way for our clients to receive data from Axuall. The table below specifies the request method used for the Axuall API endpoints.

Endpoint	Request Method	Output
Authentication	POST/auth	Receive a bearer token
SSO Initiation	GET/sso	Retrieve an URI for initiating SSO
Recipes	GET/app_req_list	Retrieve the list of recipes for a subscriber group
Facilities	GET/facility_list	Retrieve the list of facilities for a subscriber group
FSMB Artifact	GET/fsmb/artifact	Retrieve FSMB artifact
Create Invite	POST/invite	Create clinician invitation
Send Invite	POST/send_invite	Send clinician invitation
Provider Preview	GET/provider_preview	Retrieve a preview of the provider's data
List Providers	GET/providers	Retrieve a list of providers
Register Provider	POST/providers	Register a provider for Axuall
Get Provider	GET/providers/{provider_id}	Retrieve identifying clinician data
Verified Share	GET/providers/{provider_id}/verified_share	Retrieve clinician credential data
Provider Files	GET/providers/{provider_id}/files	Retrieve clinician files
Credential Changes	GET/providers/{provider_id}/changes	Retrieve clinician credential changes
Assign Workflow	POST/providers/{provider_id}/workflows	Update a provider's workflow status

What do you need to get started?

In order to use the Axuall API, the Axuall Implementation team will provide you with several pieces of information. These include the:

1. Client_id: This is an unique ID assigned to each client accessing clinician data within the Axuall database.
2. Client_secret: This is a secret known only to your application and the authorization server. It protects your resources by only granting tokens to authorized requestors.
3. Actor_id (x-axuall-actor): This is an unique ID that allows an API user to access all clinician data for a subscriber group. Without this, you will be unable to use any of the API endpoints other than Authentication.
4. App_req_id: ID of the application requirement.
5. Test providers: These providers will be used to test the integration between Axuall and systems of record. The Axuall Implementation team will set up the creation of these providers.

📘

Want to start testing immediately?

If you need to start testing immediately, you can use our test provider with the NPI of 1111111111.