# List Companies

**GET** `/companies`

Base URL: `https://api.uat.triple-a.io/api/fiat-payout/v1`

This endpoint allows API users to retrieve a list of companies they have created.

## Authorization

- oauth2 (http, bearer)

## Query parameters

- `page` (integer)
  Specify the page number
- `per_page` (integer)
  Specify the number of items per page
- `name` (string)
  company registration number to search
- `external_id` (string)

## Responses

### 200

OK

- `id` (string<uuid>)
- `external_id` (string, required)
- `native_registered_name` (string)
- `registered_name` (string, required)
  Company registered name
- `trading_name` (string)
  Company trading name
- `registration_type` (string)
- `registration_number` (string)
- `registration_date` (string<date>)
- `registration_expiry_date` (string<date>)
- `registration_country` (string<iso-3166-1-alpha3>)
- `email` (string)
- `phone_number` (string)
- `native_address` (string)
- `address` (string)
- `country_code` (string<iso-3166-1-alpha3>, required)
- `zip_code` (string)
- `city` (string)
  Residence city
- `province_state` (string)
  Residence State/Province
- `mobile_number` (string)
- `remarks` (string)
- `verification_status` ("none" | "missing" | "pending" | "failed" | "confirmed")
- `daily_quota` (number)
- `monthly_quota` (number)
- `yearly_quota` (number)
- `quota_currency` (string<iso-4217-ext>)
- `business_nature` ("AGRICULTURE_FOOD_CROPS" | "AGRICULTURE_OTHER_CROPS" | "AGIRCULTURE_FARMING" | "ENERGY_EQUIPMENT_SERVICES" | "ENERGY_NON_RENEWABLE_RESOURCES" | "ENERGY_RENEWABLES_RESOURCES" | "FINANCIAL_SERVICES_BANK" | "FINANCIAL_SERVICES_INSURANCE" | "FINANCIAL_SERVICES_INVESTMENT" | "FINANCIAL_SERVICES_LENDING" | "FINANCIAL_SERVICES_REMITTANCE" | "HEALTH_CARE_SERVICES" | "HEALTH_CARE_EQUIPMENT" | "HEALTH_CARE_PHARMA_AND_LIFE_SCIENCES" | "INDUSTRIAL_AEROSPACE_DEFENSE" | "INDUSTRIAL_CONSTRUCTION_ENGINEERING" | "INDUSTRIAL_ELECTRICAL_EQUIPMENT_MACHINERY" | "INFORMATION_TECHNOLOGY_SOFTWARE_SERVICES" | "INFORMATION_TECHNOLOGY_HARDWARE_EQUIPMENT_COMPONENTS" | "INFORMATION_TECHNOLOGY_ECOMMERCE" | "MANUFACTURING_AUTOMOBILES_AND_COMPONENTS" | "MANUFACTURING_CONSUMER_GOODS" | "MANUFACTURING_FOOD_PRODUCTS" | "MATERIALS_METAL_AND_BASIC_MATERIALS" | "MATERIALS_CHEMICALS" | "MATERIALS_CONSTRUCTION" | "MATERIALS_MANUFACTURING" | "MEDIA_AND_COMMUNICATION_TELECOMMUNICATION" | "MEDIA_AND_COMMUNICATION_MEDIA_ENTERTAINMENT_SPORTS" | "PROFESSIONAL_SERVICES_LEGAL_HR_CONSULTING" | "PROFESSIONAL_SERVICES_OTHERS" | "PUBLIC_SECTOR_GOVERNMENT_ADMINISTRATION" | "PUBLIC_SECTOR_NGOS" | "PUBLIC_SECTOR_OTHERS" | "RETAIL_TRADING_AND_DISTRIBUTION" | "RETAIL_RETAILER" | "RETAIL_FOOD_BEVERAGES" | "RETAIL_HOTELS_LEISURE_ENTERTAINMENT" | "TRANSPORTATION_ROAD_AND_RAIL" | "TRANSPORTATION_AIR" | "TRANSPORTATION_MARINE" | "TRANSPORTATION_LOGISTICS" | "UTILITIES_ENERGY" | "UTILITIES_WATER" | "REAL_ESTATE")
  Business Nature
- `created_at` (string<date-time>)
- `updated_at` (string<date-time>)
- `is_blocked` (boolean)
  Whether this sender entity is blocked for transfer operations. Managed by internal ops only.

Example:

```json
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "external_id": "my_user_millerinc01",
    "native_registered_name": "米勒",
    "registered_name": "Miller",
    "trading_name": "Miller Inc",
    "registration_type": "trade license",
    "registration_number": "001205682",
    "registration_date": "2021-02-16",
    "registration_expiry_date": "2021-02-16",
    "registration_country": "USA",
    "email": "finance@miller.com",
    "phone_number": "+13152455710",
    "native_address": "7950 路易斯路",
    "address": "7950 Lewis Rd",
    "country_code": "USA",
    "zip_code": "13305",
    "city": "New York City",
    "province_state": "New York",
    "mobile_number": "+13152455710",
    "remarks": "string",
    "verification_status": "none",
    "daily_quota": 100000,
    "monthly_quota": 200000,
    "yearly_quota": 500000,
    "quota_currency": "USD",
    "business_nature": "AGRICULTURE_FOOD_CROPS",
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z",
    "is_blocked": true
  }
]
```