An organization asset represents an entity that Availity does business with. These include payers, clearinghouses, providers, and vendors. This endpoint allows clients to query collection of organizations which are associated to a logged in user.
Find a user's organization collection with a set of parameters. The request parameters act as filters on the collection.
The client must send at least one of the following:
|id||String||Allows the client to retrieve multiple organizations by their ids. Accepts multiple |
|customerId||String||Allows the client to retrieve multiple organizations by their customer ids. Accepts multiple |
|userId||String||Allows the client to retrieve organizations that the user is a part of. Accepts a single user id parameter.|
|regions.code||String||Allows the client to retrieve organizations within the specified regions. Accepts multiple |
|statusCode||String||Allows the client to retrieve organizations with the specified status codes. Accepts multiple status code parameters. Defaults to |
|permissionId||String||Allows the client to retrieve organizations with the specified permission ids. Accepts multiple |
|getExtras||Boolean||Retrieve other info (number of licensed physicians/clinicians, specialty types, etc) for the matched organizations. Defaults to |
|primaryAdminsOnly||Boolean||When using with getExtras, it specifies if we want to see just the primary administrators. Defaults to |
|q||String||If an |
|sortBy||String||Clients can sort by name only for now.|
|sortDirection||String||Allows the client to specify a sort direction. Clients can sort by |
|offset||Number||Paging offset. Defaults to |
|limit||Number||Paging limit. Defaults to |
Retrieves by its id.
- Which taxId should I use?
- An array of taxIds is returned for each organization, and will have the first result as the "primary" taxId. The type will be either "E" (EIN) or "S" (SSN). Additional taxIds will have the type "ALTTAX" as secondary or alternative taxIds.
For selected payers, organizations can be validated using two checks. Note that the words "validated" and "verified" are used indiscriminately in all aspects of this process.
Organization validation comprises three components:
- Checking the validation status
- Prompting the user for check information
- Securing the back end
Generally, your application workflow should be:
- Get user inputs, including the organization they're using
- On submit, interrupt submission and check the organization's validation status
- If the organization status is
VERIFIED, skip to step 6
- If the organization status is not
VERIFIED, prompt the user for check information via the modal window
- After the check information modal window is dismissed, loop back to step 2.
- Allow submission, and on the back end, validate the organization again to guard against any request tampering
You can check the validation status of an organization by calling the Organization Validations endpoint. Validation is always performed in the context of an application, denoted by an application ID and a payer ID.
Note: If organization validation has not been enabled for a specific application ID / payer ID combination, the organization will always show as
The client must send all parameters
|applicationId||String||The application ID for which to validate the organization. Accepts a single application ID parameters.|
|customerId||String||The customer ID of the organization to validate. Accepts a single customer ID parameter.|
|payerId||String||The payer ID of the application for which to validate the organization. Accepts a single payer ID parameter.|
- LOCKED - The organization has been locked, and will require manual intervention from Availity to unlock.
- UNVERIFIED - The organization has not yet been verified.
- VERIFIED - The organization has been verified.
To prompt for check information, you post a specific message to the application's parent window. When you do this within the context of the Availity portal (e.g., within an Availity environment), the user sees a modal dialog for entering check information, as shown in Figure 1. While you are developing locally, however, you will not see the modal. You can verify your call is happening, however, using your browser's debugger.
The code to show the modal looks like this:
Generally, your application will make a call to your own back end services through the Availity proxy. When this is the case, open a request to Availity to secure the particular proxy configuration for organization validation. Note that you will need to pass the customer ID of the organization for validation in your proxy call.