AS2 Instances

AS2 Instances represent your organization's identity in AS2 communications. Each instance has a unique AS2 ID that trading partners use to identify you.

Overview

Before you can exchange messages with trading partners, you need to create at least one AS2 Instance. This instance defines:

  • AS2 ID - Your unique identifier in AS2 communications
  • Name - A friendly name for the instance
  • Alias - An internal reference name
  • Email - Contact email for AS2 notifications
AS2 Instances List
Serverless AS2
AS2 Instances Partner PartnerShip Certificate TrackLog
user@example.com
+ Create AS2 Instances
My AS2 ID
My AS2 Name
Status
mycompany
My Company
On
mycompany-test
My Company Test
On
mycompany-prod
My Company Production
On

Creating an AS2 Instance

To create a new AS2 Instance:

  1. Navigate to AS2 Instances

    Click on "AS2 Instances" in the navigation menu.

  2. Click Create

    Click the "+ Create AS2 Instances" link to open the creation form.

  3. Fill in the Details

    Enter the required information for your AS2 Instance.

  4. Save

    Click "Save" to create your AS2 Instance.

Create AS2 Instance Form
Serverless AS2
AS2 Instances Partner PartnerShip Certificate TrackLog
user@example.com
Create AS2
Save
OnOff

Editing an AS2 Instance

Click on an AS2 ID in the list to edit the instance. The edit view also shows related partnerships:

Edit AS2 Instance
Serverless AS2
AS2 Instances Partner PartnerShip Certificate TrackLog
user@example.com
Edit AS2
Save
OnOff
Related Partnership +
My AS2 ID
My Name
Partner AS2 ID
Partner Name
mycompany
My Company
amazon
Amazon
1 - 1 / 1

Field Reference

Field Required Description
my_as2_id Yes Your unique AS2 identifier. This is what trading partners use to address messages to you.
my_name Yes A friendly display name for this AS2 instance.
my_as2_alias Yes An internal alias used to identify your private key in the certificate keystore. When you create a certificate, this value is automatically used as the default privateKeyAlias. Choose a meaningful name that helps you identify this AS2 identity.
my_email Yes Contact email address included in AS2 message headers.
status No Enable or disable this AS2 instance. Disabled instances cannot send or receive messages.
Tip

Your AS2 ID should be agreed upon with your trading partner beforehand. Many partners have specific naming conventions they require.