WIwirexapp
Corporations

Get corporation

Retrieves corporation details that were provided during registration/KYB, along with its status, verification status and wallet status.

get/api/v1/corporations

Request

  • Base URL
    https://api-business.wirexapp.com
  • URL
    https://api-business.wirexapp.com/api/v1/corporations
  • Auth
    API key in header Authorization

Request body */*

RequestEmptyRequest required

Response

OK

corporation_addressstring required

Address of account abstraction registered as corporation main wallet

corporation_idstring required

Id of the corporation in Wirex internal system

corporation_namestring required

Registered name of the corporation

corporation_type'None' | 'LimitedLiability' | 'SoleTrader' | 'Partnership' | 'PublicLimitedCompany' | 'JointStockCompany' | 'Charity' required
freshdesk_idstring required

Id that can be used to restore freshdesk chats

owner_addressstring required

Address of the owner of the corporation

passed_levelsResponseVerificationLevel[] required

Verification levels that were passed by the corporation (This field is obsolete and will be removed in future releases, use VerificationLevels instead)

registration_numberstring required

Registration number of the corporation

short_idstring

Short id of the corporation. Set at registration but not yet exposed on the read path: service-corporation's CorporationInfoModel does not carry it, so this endpoint omits it until it does.

status'None' | 'Pending' | 'Active' | 'Blocked' | 'Deleted' required
status_reasonstring

Reason for the status

verification_status'None' | 'Pending' | 'Applied' | 'InReview' | 'Approved' | 'Rejected' | 'Canceled' required

Example response

{
  "actions": [
    {
      "relative_path": "/api/v1/cards/plastic"
    }
  ],
  "capabilities": [
    {
      "prerequisites": [
        "[SepaAccount]"
      ],
      "status_reason": "Activation in progress, please wait for confirmation",
      "verification_requirements": [
        {
          "order": 1
        }
      ]
    }
  ],
  "corporation_address": "0xA7E41d5680dE394EaA2ed417169DFf56840Fb3EE",
  "corporation_contact_details": {
    "email": "jorge.black@acme.com",
    "name": "Jorge Black",
    "phone_number": "+61405832003"
  },
  "corporation_id": "00000000-0000-0000-0000-000000000001",
  "corporation_name": "Acme Inc",
  "corporation_registration_address": {
    "city": "San Francisco",
    "country": "US",
    "line1": "123 Main St",
    "line2": "Suite 200",
    "postal_code": "94107",
    "state": "CA"
  },
  "freshdesk_id": "00000000-0000-0000-0000-000000000001",
  "owner_address": "0xA7E41d5680dE394EaA2ed417169DFf56840Fb3EE",
  "registration_number": "12345678",
  "short_id": "acme.wirexpaychain.corp",
  "status_reason": "KYB verification passed"
}

Changes

No recorded changes to this operation across all 1 revision of this API.