Skip to main content

Fetch an Identity

Suggest Edits

Overview​

Retrieve the details of a specific Identity by its unique identifier. This endpoint returns comprehensive information about the person or business including personal details, business information, and metadata.

Resource Access​

Production (api.ahrvo.network)

GET https://api.ahrvo.network/payments/na/identities/\{identity_id}

Staging (gateway.ahrvo.network)

GET http://gateway.ahrvo.network/payments/na/identities/\{identity_id}

Arguments​

AttributeMandatory / OptionalDescription
identity_idMandatoryThe unique ID of the identity to retrieve

Example Request​

curl -X GET https://gateway.ahrvo.network/payments/na/identities/IDxxxxxxxxxxxxxxxxxx \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <base64_encoded_credentials>"

Example Response (Business Identity)​

{
  "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",
    "title": "CEO",
    "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,
    "principal_percentage_ownership": 100,
    "mcc": "5812",
    "annual_card_volume": 1200000000,
    "max_transaction_amount": 500000,
    "ach_max_transaction_amount": 250000
  },
  "additional_underwriting_data": {
    "business_description": "Online retail store selling electronics",
    "refund_policy": "FULL_REFUNDS",
    "merchant_agreement_accepted": true,
    "credit_check_allowed": true,
    "card_volume_distribution": {
      "card_present_percentage": 30,
      "ecommerce_percentage": 60,
      "mail_order_telephone_order_percentage": 10
    }
  },
  "tags": {
    "merchant_tier": "premium",
    "onboarding_date": "2025-12-10"
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/identities/IDxxxxxxxxxxxxxxxxxx"
    },
    "application": {
      "href": "https://api.ahrvo.network/payments/na/applications/APxxxxxxxxxxxxxxxxxx"
    },
    "merchants": {
      "href": "https://api.ahrvo.network/payments/na/identities/IDxxxxxxxxxxxxxxxxxx/merchants"
    },
    "associated_identities": {
      "href": "https://api.ahrvo.network/payments/na/identities/IDxxxxxxxxxxxxxxxxxx/associated_identities"
    }
  }
}

Example Response (Personal Identity)​

{
  "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": {
    "customer_since": "2025-12"
  },
  "_links": {
    "self": {
      "href": "https://api.ahrvo.network/payments/na/identities/IDyyyyyyyyyyyyyyyyyy"
    },
    "application": {
      "href": "https://api.ahrvo.network/payments/na/applications/APxxxxxxxxxxxxxxxxxx"
    }
  }
}

Important Notes​

  • Tax IDs and SSNs are never returned in responses; only tax_id_provided and business_tax_id_provided boolean flags
  • Sensitive information is protected and not included in API responses
  • The entity object structure varies based on the identity type (BUSINESS vs PERSONAL)

API Documentation​