Add Public Certificate

Uploads and associates a trading partner's public certificate with a communication channel for AS2 signature verification or encryption.

Endpoint

POST /v2/certificates/add-public

Request Body

Field	Type	Required	Constraints	Description
commId	integer	Yes	Must be a valid Comm ID	Communication channel to associate the public certificate with
certType	CertificateType	Yes	See ENUMs	Type of certificate (X509, PGP, SSH)
keyId	string	No	—	Key identifier for the partner's certificate
userId	string	No	—	User identifier associated with this certificate
beginUsage	datetime	No	ISO 8601	Date and time when the certificate becomes active
usage	CertificateUsage	No	See ENUMs	Intended usage (Encryption, Signature, etc.)
partnerCommId	string	No	—	Partner's AS2 communication identifier
partnerUrl	string	No	Valid URL	Partner's AS2 endpoint URL
cert	string	No	Base64-encoded	The partner's public certificate encoded as Base64

{
  "commId": 5001,
  "certType": "X509",
  "keyId": "partner-public-cert-2026",
  "userId": "partner-edi",
  "beginUsage": "2026-05-07T00:00:00Z",
  "usage": "EncryptionAndSignature",
  "partnerCommId": "PARTNER-AS2-ID",
  "partnerUrl": "https://as2.tradingpartner.com/receive",
  "cert": "MIIDXTCCAkWgAwIBAgIJAJC1HiIAZAiIMA0GCSqGSIb3Df..."
}

Response

Returns the updated CommIDInfo object reflecting the newly associated public certificate.

{
  "success": true,
  "data": {
    "commId": 5001,
    "mailboxId": 101,
    "commType": "as2",
    "identifier": "MYCOMPANY-AS2",
    "status": "Active",
    "useType": "Production",
    "privateKeyRequired": true,
    "withCerts": true
  }
}

ENUMs

This endpoint uses the CertificateType and CertificateUsage ENUMs. See ENUMs Reference for all valid values.

Code Examples

cURL

curl -X POST "https://rest.ecgrid.io/v2/certificates/add-public" \
  -H "X-API-Key: $ECGRID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "commId": 5001, "certType": "X509", "keyId": "partner-public-cert-2026", "userId": "partner-edi", "beginUsage": "2026-05-07T00:00:00Z", "usage": "EncryptionAndSignature", "partnerCommId": "PARTNER-AS2-ID", "partnerUrl": "https://as2.tradingpartner.com/receive", "cert": "MIIDXTCCAkWgAwIBAgIJAJC1HiIAZAiIMA0GCSqGSIb3Df..." }'

C#

// .NET 10 — Upload a trading partner's public certificate to a comm channel
// Public certificate is typically received from the partner as a .cer or .pem file
var certBytes = await File.ReadAllBytesAsync("path/to/partner-public.cer");
var certBase64 = Convert.ToBase64String(certBytes);

var request = new
{
    commId = 5001,
    certType = "X509",
    keyId = "partner-public-cert-2026",
    userId = "partner-edi",
    beginUsage = DateTime.UtcNow.ToString("o"),
    usage = "EncryptionAndSignature",
    partnerCommId = "PARTNER-AS2-ID",
    partnerUrl = "https://as2.tradingpartner.com/receive",
    cert = certBase64
};

using var response = await httpClient.PostAsJsonAsync(
    "https://rest.ecgrid.io/v2/certificates/add-public",
    request);

response.EnsureSuccessStatusCode();

var result = await response.Content.ReadFromJsonAsync<ApiResponse<CommIdInfo>>();
Console.WriteLine($"Public certificate added to Comm {result.Data.CommId}. WithCerts: {result.Data.WithCerts}");

Java

import java.net.URI;
import java.net.http.*;

String apiKey = System.getenv("ECGRID_API_KEY");

String body = "{ \"commId\": 5001, \"certType\": \"X509\", \"keyId\": \"partner-public-cert-2026\", \"userId\": \"partner-edi\", \"beginUsage\": \"2026-05-07T00:00:00Z\", \"usage\": \"EncryptionAndSignature\", \"partnerCommId\": \"PARTNER-AS2-ID\", \"partnerUrl\": \"https://as2.tradingpartner.com/receive\", \"cert\": \"MIIDXTCCAkWgAwIBAgIJAJC1HiIAZAiIMA0GCSqGSIb3Df...\" }";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://rest.ecgrid.io/v2/certificates/add-public"))
    .header("X-API-Key", apiKey)
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
    request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Node.js

const apiKey = process.env.ECGRID_API_KEY;
const url = 'https://rest.ecgrid.io/v2/certificates/add-public';

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ "commId": 5001, "certType": "X509", "keyId": "partner-public-cert-2026", "userId": "partner-edi", "beginUsage": "2026-05-07T00:00:00Z", "usage": "EncryptionAndSignature", "partnerCommId": "PARTNER-AS2-ID", "partnerUrl": "https://as2.tradingpartner.com/receive", "cert": "MIIDXTCCAkWgAwIBAgIJAJC1HiIAZAiIMA0GCSqGSIb3Df..." }),
});

const data = await response.json();
console.log(data);

Python

import os, requests

api_key = os.environ["ECGRID_API_KEY"]
headers = {"X-API-Key": api_key}
url = "https://rest.ecgrid.io/v2/certificates/add-public"

response = requests.post(
    url,
    json={ "commId": 5001, "certType": "X509", "keyId": "partner-public-cert-2026", "userId": "partner-edi", "beginUsage": "2026-05-07T00:00:00Z", "usage": "EncryptionAndSignature", "partnerCommId": "PARTNER-AS2-ID", "partnerUrl": "https://as2.tradingpartner.com/receive", "cert": "MIIDXTCCAkWgAwIBAgIJAJC1HiIAZAiIMA0GCSqGSIb3Df..." },
    headers=headers,
)

response.raise_for_status()
print(response.json())

See Also

• Add Private Certificate
• Create Certificate
• Renew Certificate
• Terminate Certificate
• Get Comm
• ENUMs Reference