v1

latestOpenAPI 3.0.02026-07-26167441.9 MB
Entities (Banking Connectivity)

Get Entity Details (Banking Connectivity)

get/banking/entities/{entity_id}

Path parameters

entity_idstring required

The id of the entity obtained from Create Entity

Response

account_idstring
merchant_entity_idstring
national_entitystring

Example response

{
  "account_id": "550e8400-e29b-41d4-a716-446655440000",
  "merchant_entity_id": "merchant_user_12345",
  "national_entity": "INDIVIDUAL",
  "phone": {
    "country_code": "+1",
    "number": "2025551234"
  },
  "address": {
    "address_line_1": "123 Main St",
    "address_line_2": "Apt 4B",
    "building_number_1": "123",
    "city": "San Francisco",
    "state": "CA",
    "zip_code": "94102",
    "country": "US"
  },
  "entity_detail": {
    "individual": {
      "first_name": "John",
      "last_name": "Doe",
      "email": "john@example.com",
      "date_of_birth": "1990-01-15",
      "gender": "M",
      "country_of_residence": "US",
      "tax_information": [
        {
          "country": "US",
          "tax_id": "123-45-6789",
          "tax_id_type": "SSN",
          "is_primary": true
        }
      ],
      "document": {
        "document_type": "SSN",
        "document_number": "123-45-6789",
        "issuing_country": "US",
        "issued_at": "2010-01-15",
        "expires_at": "2030-01-15"
      }
    }
  }
}