Skip to main content
GET
/
v1
/
enrollment
Get current enrollment status
curl --request GET \
  --url https://sandbox-api.va.meridianpay.com/v1/enrollment
{
  "id": "enrollment_123",
  "createdAt": "2026-04-01T12:00:00Z",
  "updatedAt": "2026-04-01T12:05:00Z",
  "status": "ACTIVE",
  "statusReason": "REVOKED",
  "latestInformationRequest": {
    "id": "ir_01HZX1A2B3C4D5E6F7G8H9J0K",
    "status": "DRAFT",
    "subjectType": "ENROLLMENT",
    "subjectId": "subject-123",
    "validationStatus": "MISSING",
    "createdAt": "2026-04-01T12:00:00Z",
    "updatedAt": "2026-04-01T12:05:00Z",
    "decision": "PENDING"
  }
}

Headers

​
Authorization
string

Bearer authentication header of the form Bearer {token}. Required for client-server (JWT) authentication. See Authentication.

​
X-Meridian-Program-Id
string

Identifies the program context for the request. Required for server-to-server (HMAC) authentication. See Authentication.

​
X-Meridian-User-Id
string

Identifies the Meridian user targeted by the request. Required for server-to-server (HMAC) authentication with MULTI_USER integrations; omit for SINGLE_USER. See Authentication.

​
X-Meridian-Api-Key
string

Partner API key issued by Meridian during provisioning. Required for server-to-server (HMAC) authentication. See Authentication.

​
X-Meridian-Timestamp
string

Current time in milliseconds since the Unix epoch. Must be within 60 seconds of the request. Required for server-to-server (HMAC) authentication. See Authentication.

​
X-Meridian-Signature
string

HMAC SHA-256 signature of the canonical request string, computed per request. Required for server-to-server (HMAC) authentication. See Authentication for how to construct it.

Response

The current or freshly-created enrollment for the authenticated account

Enrollment state for the authenticated Meridian account

​
id
string
required

Unique identifier of the enrollment

Example:

"enrollment_123"

​
createdAt
string<date-time>
required

Timestamp when the enrollment was created

Example:

"2026-04-01T12:00:00Z"

​
updatedAt
string<date-time>
required

Timestamp when the enrollment was last updated

Example:

"2026-04-01T12:05:00Z"

​
status
enum<string>
required

Current status of the enrollment

Available options:
INACTIVE,
ACTIVE
Example:

"ACTIVE"

​
statusReason
enum<string> | null

Reason for the current enrollment status, when one applies

Available options:
REVOKED
Example:

"REVOKED"

​
latestInformationRequest
Information Request Summary · object | null

Summary Information Request entry for the authenticated Meridian account