Skip to main content
GET
/
v1
/
information-requests
/
{informationRequestId}
Get an Information Request by ID
curl --request GET \
  --url https://sandbox-api.va.meridianpay.com/v1/information-requests/{informationRequestId}
{
  "id": "usrsk-h2vuw0jaswgpzyxluhpz2709",
  "status": "DRAFT",
  "subjectType": "ENROLLMENT",
  "subjectId": "usrem-coxxvofk5km4tz1r28c7gcfk",
  "validationStatus": "VALID",
  "decision": null,
  "title": "Business Verification",
  "createdAt": "2026-06-09T14:37:04Z",
  "updatedAt": "2026-06-09T14:41:12Z",
  "requirements": [
    {
      "requirementKey": "associated_persons",
      "title": "Associated persons",
      "description": "Identity document: upload a passport, or both sides of a driver's license (front and back), plus a proof of address.",
      "cardinality": {
        "mode": "MULTIPLE",
        "min": 1,
        "max": null
      },
      "dataSchema": {
        "type": "object",
        "required": [
          "roles",
          "ownershipPercentage",
          "person"
        ],
        "properties": {
          "roles": {
            "type": "array",
            "title": "Roles",
            "widget": "multiselect",
            "minItems": 1,
            "items": {
              "type": "string",
              "enum": [
                "CONTROL_PERSON",
                "BENEFICIAL_OWNER",
                "SIGNER",
                "ADMIN",
                "DIRECTOR",
                "REPRESENTATIVE",
                "BUSINESS_CONTROLLER",
                "BUSINESS_ADMIN",
                "SHAREHOLDER"
              ]
            }
          },
          "title": {
            "type": "string",
            "title": "Title",
            "widget": "text",
            "minLength": 1,
            "maxLength": 150
          },
          "ownershipPercentage": {
            "type": "integer",
            "title": "Ownership percentage",
            "widget": "number",
            "minimum": 0,
            "maximum": 100
          },
          "person": {
            "type": "object",
            "title": "Person",
            "required": [
              "firstName",
              "lastName",
              "dateOfBirth",
              "citizenship",
              "email",
              "phoneNumber",
              "taxNumber",
              "physicalAddress"
            ],
            "properties": {
              "firstName": {
                "type": "string",
                "title": "First name",
                "widget": "text",
                "minLength": 1,
                "maxLength": 150
              },
              "lastName": {
                "type": "string",
                "title": "Last name",
                "widget": "text",
                "minLength": 1,
                "maxLength": 150
              },
              "dateOfBirth": {
                "type": "string",
                "title": "Date of birth",
                "widget": "date",
                "format": "date"
              },
              "citizenship": {
                "type": "string",
                "title": "Citizenship",
                "widget": "text",
                "minLength": 2,
                "maxLength": 2
              },
              "email": {
                "type": "string",
                "title": "Email",
                "widget": "email",
                "format": "email"
              },
              "phoneNumber": {
                "type": "string",
                "title": "Phone",
                "widget": "phone",
                "minLength": 2,
                "maxLength": 50
              },
              "taxNumber": {
                "type": "string",
                "title": "Tax number",
                "widget": "text",
                "minLength": 2,
                "maxLength": 50
              },
              "physicalAddress": {
                "type": "object",
                "title": "Residential address",
                "required": [
                  "addressLine1",
                  "city",
                  "stateProvince",
                  "postalCode",
                  "countryCode"
                ],
                "properties": {
                  "addressLine1": {
                    "type": "string",
                    "title": "Address line 1",
                    "widget": "text",
                    "minLength": 2,
                    "maxLength": 150
                  },
                  "addressLine2": {
                    "type": "string",
                    "title": "Address line 2",
                    "widget": "text",
                    "minLength": 1,
                    "maxLength": 150
                  },
                  "city": {
                    "type": "string",
                    "title": "City",
                    "widget": "text",
                    "minLength": 2,
                    "maxLength": 50
                  },
                  "stateProvince": {
                    "type": "string",
                    "title": "State/province",
                    "widget": "text",
                    "minLength": 2,
                    "maxLength": 50
                  },
                  "postalCode": {
                    "type": "string",
                    "title": "Postal code",
                    "widget": "text",
                    "minLength": 3,
                    "maxLength": 10
                  },
                  "countryCode": {
                    "type": "string",
                    "title": "Country code",
                    "widget": "text",
                    "minLength": 2,
                    "maxLength": 3
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "documents": [
        {
          "documentKey": "passport",
          "minFiles": 0,
          "maxFiles": 1,
          "supportedMimeTypes": [
            "application/pdf",
            "image/jpeg",
            "image/png"
          ],
          "maxFileSizeBytes": 10485760
        },
        {
          "documentKey": "drivers_license_front",
          "minFiles": 0,
          "maxFiles": 1,
          "supportedMimeTypes": [
            "application/pdf",
            "image/jpeg",
            "image/png"
          ],
          "maxFileSizeBytes": 10485760
        },
        {
          "documentKey": "drivers_license_back",
          "minFiles": 0,
          "maxFiles": 1,
          "supportedMimeTypes": [
            "application/pdf",
            "image/jpeg",
            "image/png"
          ],
          "maxFileSizeBytes": 10485760
        },
        {
          "documentKey": "address_proof",
          "minFiles": 1,
          "maxFiles": 1,
          "supportedMimeTypes": [
            "application/pdf"
          ],
          "maxFileSizeBytes": 10485760
        }
      ],
      "validationStatus": "VALID",
      "entries": [
        {
          "entryId": "associated_persons:0",
          "clientReferenceId": "representative-1",
          "validationStatus": "VALID",
          "data": {
            "roles": [
              "BENEFICIAL_OWNER",
              "CONTROL_PERSON",
              "SIGNER"
            ],
            "title": "CEO",
            "ownershipPercentage": 100,
            "person": {
              "firstName": "John",
              "lastName": "Smith",
              "dateOfBirth": "1986-06-01",
              "citizenship": "US",
              "email": "john.smith@acme.example",
              "phoneNumber": "+12813308004",
              "taxNumber": "078-05-1120",
              "physicalAddress": {
                "addressLine1": "100 Legends Way",
                "addressLine2": "Apt 5",
                "city": "Boston",
                "stateProvince": "MA",
                "postalCode": "02114",
                "countryCode": "US"
              }
            }
          },
          "documents": [
            {
              "documentKey": "passport",
              "files": [
                {
                  "fileName": "passport.png",
                  "mimeType": "image/png",
                  "sizeBytes": 482311,
                  "storageKey": "uploads/usrsk-h2vuw0jaswgpzyxluhpz2709/associated_persons:0/passport/passport.png"
                }
              ]
            },
            {
              "documentKey": "drivers_license_front",
              "files": []
            },
            {
              "documentKey": "drivers_license_back",
              "files": []
            },
            {
              "documentKey": "address_proof",
              "files": [
                {
                  "fileName": "residential_address_proof.pdf",
                  "mimeType": "application/pdf",
                  "sizeBytes": 204800,
                  "storageKey": "uploads/usrsk-h2vuw0jaswgpzyxluhpz2709/associated_persons:0/address_proof/residential_address_proof.pdf"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

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.

Path Parameters

​
informationRequestId
string
required

Response

The Information Request details for the authenticated account

Detailed Information Request payload for the authenticated Meridian account

​
id
string
required

Unique identifier of the Information Request

Example:

"ir_01HZX1A2B3C4D5E6F7G8H9J0K"

​
status
enum<string>
required

Current status of the Information Request

Available options:
DRAFT,
PROCESSING_SUBMISSION,
PENDING_REVIEW,
COMPLETED,
CANCELED
Example:

"DRAFT"

​
subjectType
enum<string>
required

Type of entity the Information Request is associated with

Available options:
ENROLLMENT
Example:

"ENROLLMENT"

​
subjectId
string
required

Identifier of the entity the Information Request is associated with

Example:

"enrollment_123"

​
requirements
Information Request Requirement · object[]
required

Requirement contracts and submitted entries for this Information Request

​
validationStatus
enum<string>
required

Validation status of the Information Request data

Available options:
MISSING,
VALID,
INVALID
Example:

"MISSING"

​
createdAt
string<date-time>
required

Timestamp when the Information Request was created

Example:

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

​
updatedAt
string<date-time>
required

Timestamp when the Information Request was last updated

Example:

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

​
decision
enum<string> | null

Current manual review decision status for the Information Request, if it has been reviewed

Available options:
PENDING,
APPROVED,
REJECTED
Example:

"PENDING"

​
title
string | null

Display title for the Information Request

Example:

"Business Verification"