Configure Your Vault to Receive AERs from Vault API

Vault Safety integrates with Vault API to allow organizations to exchange AERs through the Receive E2B API endpoint.

Sections in This Article

Receiving AERs from Vault API

Vault Safety supports AER intake by passing a source E2B file through the API using the Receive E2B endpoint. Before your vault can receive AERs from the Vault API Receive E2B endpoint, an administrator must set up a Partner Exchange Transmission Profile and ensure the user initiating the API is set up correctly.

Receive an E2B Transmission provides more information about how Vault Safety processes inbound E2B transmissions.

Set Up a Partner Exchange Transmission Profile

You must configure a Partner Exchange Profile to use the Receive E2B API, which is a type of Transmission Profile.

Vault Safety comes with a system-provided Partner Exchange Profile that you can edit. Manage Transmission Profiles provides instructions on setting up Transmission Profiles.

When setting up the Partner Exchange Profile, see the following guidance on setting the Origin and Destination:

  • Origin: Select the organization set up as Vault Customer (vault_customer__v) for your vault.
  • Origin ID: Enter the identifier for the organization that will receive E2B files from the API.
    This field is required to match API calls with the correct Transmission Profile, and corresponds to the destinationId API parameter.
  • Destination: Select the trading partner organization that will send the E2B files.
  • Destination ID: Enter the identifier for the organization that will send the E2B files.
    This field is required to match API calls with the correct Transmission Profile, and corresponds to the originId API parameter.

API User Setup Requirements

The user initiating the API must meet the following requirements in the receiving vault:

  • The User record must link to the Organization receiving the transmission in the Organization field.
    Edit User records in Admin > Users & Groups.
  • The user must have permissions to create Transmission (transmission__v) objects and Case > Source > Adverse Event Report (case__v>source__v>adverse_event_report__v) documents.

System Configuration Considerations

Note the following considerations when receiving Cases through the API:

  • VQL criteria may cause the job to fail. Do not configure VQL criteria for Organizations, Users, or Transmission Profiles in the following records:
    • The Transmission (transmission__v) object
    • The AER (case_version__v>aer__v) Case object type
    • The Case > Source > Adverse Event Report (case__v>source__v>adverse_event_report__v) document type
  • All non-standard mandatory fields must have a default value for the following records:
    • The Transmission (transmission__v) object
    • The AER (case_version__v>aer__v) Case object type
    • The Case > Source > Adverse Event Report (case__v>source__v>adverse_event_report__v) document type

Using the Receive E2B API

Once you’ve set up the Transmission Profile and user account, the Vault Developer’s Portal provides more information about using the Receive E2B API endpoint.


Configure Custom AS2 Gateways
Configure Aggregate Reporting Families
Feedback?