Skip to main content

Update an Identity

Suggest Edits

Overview​

Update existing Identity details including personal information, business information, or metadata tags. Note that updating merchant identities may require re-verification and could affect their ability to process payments temporarily.

Resource Access​

Production (api.ahrvo.network)

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

Staging (gateway.ahrvo.network)

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

Arguments​

AttributeMandatory / OptionalDescription
identity_idMandatoryThe unique ID of the identity to update
entityOptionalObject containing updated personal or business details
tagsOptionalUpdated key-value metadata

Example Request​

curl -X PUT https://gateway.ahrvo.network/payments/na/identities/IDxxxxxxxxxxxxxxxxxx \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <base64_encoded_credentials>" \
  -d '{
    "entity": {
      "business_phone": "4155559999",
      "email": "newemail@acme.com",
      "business_address": {
        "line1": "456 New Business St",
        "line2": "Suite 200",
        "city": "San Francisco",
        "region": "CA",
        "postal_code": "94105",
        "country": "USA"
      },
      "annual_card_volume": 1500000000,
      "max_transaction_amount": 750000
    },
    "tags": {
      "merchant_tier": "enterprise",
      "last_updated": "2025-12-10"
    }
  }'

Example Response​

{
  "id": "IDxxxxxxxxxxxxxxxxxx",
  "created_at": "2025-12-10T18:00:00Z",
  "updated_at": "2025-12-10T19:30:00Z",
  "application": "APxxxxxxxxxxxxxxxxxx",
  "type": "BUSINESS",
  "identity_roles": ["SELLER"],
  "entity": {
    "business_name": "Acme Corporation",
    "business_type": "CORPORATION",
    "doing_business_as": "Acme Store",
    "business_address": {
      "line1": "456 New Business St",
      "line2": "Suite 200",
      "city": "San Francisco",
      "region": "CA",
      "postal_code": "94105",
      "country": "USA"
    },
    "business_phone": "4155559999",
    "business_tax_id_provided": true,
    "first_name": "John",
    "last_name": "Doe",
    "email": "newemail@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": 1500000000,
    "max_transaction_amount": 750000
  },
  "tags": {
    "merchant_tier": "enterprise",
    "last_updated": "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"
    }
  }
}

Updatable Fields​

You can update most fields in the entity object:

Personal Information​

  • first_name, last_name, title
  • email, phone
  • personal_address

Business Information​

  • business_name, doing_business_as
  • business_address, business_phone
  • mcc
  • annual_card_volume, max_transaction_amount, ach_max_transaction_amount

Non-Updatable Fields​

  • tax_id and business_tax_id (cannot be changed after creation)
  • dob (date of birth)
  • business_type

Important Notes​

  • Re-Verification Required: Significant changes (e.g., business address, legal name) may trigger merchant re-verification
  • Processing Impact: During re-verification, the merchant may not be able to process new transactions
  • Partial Updates: You only need to include fields you want to update
  • Tags Replacement: The entire tags object is replaced, not merged

API Documentation​