Skip to main content

List Identities

Suggest Edits

Overview​

Retrieve a paginated list of Identity resources. This endpoint supports filtering by business name, personal name, email, or custom tags to help you find specific identities.

Resource Access​

Production (api.ahrvo.network)

GET https://api.ahrvo.network/payments/na/identities

Staging (gateway.ahrvo.network)

GET http://gateway.ahrvo.network/payments/na/identities

Arguments​

AttributeMandatory / OptionalDescription
limitOptionalThe number of items to return (default: 5)
business_nameOptionalFilter by the full business name
first_nameOptionalFilter by first name
last_nameOptionalFilter by last name
emailOptionalFilter by email address
tags.keyOptionalFilter by a specific tag key-value pair
after_cursorOptionalReturn every resource created after the cursor value

Example Request​

curl -X GET "https://gateway.ahrvo.network/payments/na/identities?limit=10&business_name=Acme" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <base64_encoded_credentials>"

Example Response​

{
  "_embedded": {
    "identities": [
      {
        "id": "IDxxxxxxxxxxxxxxxxxx",
        "created_at": "2025-12-10T18:00:00Z",
        "updated_at": "2025-12-10T18:00:00Z",
        "application": "APxxxxxxxxxxxxxxxxxx",
        "type": "BUSINESS",
        "identity_roles": ["SELLER"],
        "entity": {
          "business_name": "Acme Corporation",
          "business_type": "CORPORATION",
          "doing_business_as": "Acme Store",
          "business_address": {
            "line1": "123 Business St",
            "line2": null,
            "city": "San Francisco",
            "region": "CA",
            "postal_code": "94105",
            "country": "USA"
          },
          "business_phone": "4155551234",
          "business_tax_id_provided": true,
          "first_name": "John",
          "last_name": "Doe",
          "email": "john@acme.com",
          "phone": "4155551234",
          "dob": {
            "year": 1985,
            "month": 6,
            "day": 15
          },
          "personal_address": {
            "line1": "456 Personal Ave",
            "line2": null,
            "city": "San Francisco",
            "region": "CA",
            "postal_code": "94102",
            "country": "USA"
          },
          "tax_id_provided": true,
          "mcc": "5812",
          "annual_card_volume": 1200000000,
          "max_transaction_amount": 500000
        },
        "tags": {
          "merchant_tier": "premium"
        },
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/identities/IDxxxxxxxxxxxxxxxxxx"
          }
        }
      },
      {
        "id": "IDyyyyyyyyyyyyyyyyyy",
        "created_at": "2025-12-09T14:30:00Z",
        "updated_at": "2025-12-09T14:30:00Z",
        "application": "APxxxxxxxxxxxxxxxxxx",
        "type": "PERSONAL",
        "identity_roles": ["BUYER"],
        "entity": {
          "first_name": "Jane",
          "last_name": "Smith",
          "email": "jane.smith@example.com",
          "phone": "4155555678",
          "personal_address": {
            "line1": "789 Customer Rd",
            "line2": "Apt 4B",
            "city": "Oakland",
            "region": "CA",
            "postal_code": "94612",
            "country": "USA"
          },
          "dob": {
            "year": 1990,
            "month": 3,
            "day": 22
          },
          "tax_id_provided": true
        },
        "tags": {},
        "_links": {
          "self": {
            "href": "https://api.ahrvo.network/payments/na/identities/IDyyyyyyyyyyyyyyyyyy"
          }
        }
      }
    ]
  },
  "page": {
    "offset": 0,
    "limit": 10,
    "count": 2
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/identities?limit=10&business_name=Acme"
    }
  }
}

Filtering Examples​

By Business Name:

curl -X GET "https://gateway.ahrvo.network/payments/na/identities?business_name=Acme%20Corporation"

By Email:

curl -X GET "https://gateway.ahrvo.network/payments/na/identities?email=john@acme.com"

By Tag:

curl -X GET "https://gateway.ahrvo.network/payments/na/identities?tags.merchant_tier=premium"

By Name:

curl -X GET "https://gateway.ahrvo.network/payments/na/identities?first_name=John&last_name=Doe"

API Documentation​