Get a Company

GET/companies/{companyId}

This endpoint allows API users to retrieve the company they have created by its id.

Path Parameters

companyIdstringrequired

Response

idstring<uuid>

external_idstring

native_registered_namestring

registered_namestring

Company registered name

trading_namestring

Company trading name

registration_typestring

registration_numberstring

registration_datestring<date>

registration_expiry_datestring<date>

registration_countrystring<iso-3166-1-alpha3>

emailstring

phone_numberstring

native_addressstring

addressstring

country_codestring<iso-3166-1-alpha3>

zip_codestring

citystring

Residence city

province_statestring

Residence State/Province

mobile_numberstring

remarksstring

verification_status"none" | "missing" | "pending" | "failed" | "confirmed"

daily_quotanumber

monthly_quotanumber

yearly_quotanumber

quota_currencystring<iso-4217-ext>

Business Nature

created_atstring<date-time>

updated_atstring<date-time>

is_blockedboolean

Whether this sender entity is blocked for transfer operations. Managed by internal ops only.

Error defines errors may be returned from the system.

messagestring

errorsobject[]

Show errors properties

errorCodestring

messagestring

Error defines errors may be returned from the system.

messagestring

errorsobject[]

Show errors properties

errorCodestring

messagestring

const response = await fetch(`https://api.uat.triple-a.io/api/fiat-payout/v1/companies/${companyId}`, { method: 'GET', headers: { 'Authorization': 'Bearer <token>' } }); const data = await response.json();

import requests response = requests.request( "GET", "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/{companyId}", headers={ "Authorization": "Bearer <token>" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>", nil) req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" response = http.request(request) puts response.body

{ "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 }