Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
business

Get Business by Email

Fetch a business by their email address if it exists. This API returns a 404 if the business does not exist

post/get-by-email

Request body

emailstring email required

Email address of the business

Example request

{
  "email": "elian_prosacco30@example.org"
}

Response

success

businessIdstring uuid required

Business ID

companyNamestring required

Name of the Company

registrationCountrystring

Country to which, company is registered (in ISO 3166 alpha-2 format)

registrationNumberstring required
entityType'LIMITED_LIABILITY_COMPANY' | 'PUBLICLY_LISTED_COMPANY' | 'SOLE_PROPRIETOR' | 'PARTNERSHIP' | 'CORPORATION' | 'TRUST' | 'PRIVATE_FOUNDATION' | 'CHARITY' | 'NONPROFIT_ORGANIZATION'

A type of legal entity

missingFieldsstring[]
outboundLimitAllowedstring

Outbound limit allowed

outboundLimitConsumedstring

Outbound limit consumed

Example response

{
  "companyName": "Abc123 Ltd",
  "registrationCountry": "EE",
  "registrationNumber": "43434564665756",
  "incorporatedOn": {
    "year": 1980,
    "month": 12,
    "day": 3
  },
  "legalAddress": {
    "addressLine1": "Lootsa 1",
    "city": "Tallinn",
    "postalCode": "10118",
    "state": "10118",
    "country": "EE"
  },
  "primaryUser": {
    "firstName": "Jane",
    "lastName": "Doe",
    "mobile": {
      "countryCode": "+372",
      "number": "56272888"
    }
  },
  "missingFields": [
    "incorporatedOn",
    "entityType"
  ],
  "outboundLimitAllowed": "7500000",
  "outboundLimitConsumed": "1000"
}