Skip to main content
POST
/
v2
/
onboarding
Get Onboarding Data
curl --request POST \
  --url https://api.topograph.co/v2/onboarding \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "id": "932884117",
  "countryCode": "FR",
  "dataPoints": [
    "companyProfile"
  ],
  "metadata": {}
}
'
{
  "request": {
    "country": "FR",
    "dataPoints": [
      "<string>"
    ],
    "documents": [
      "<string>"
    ],
    "companyId": "932884117",
    "requestId": "request-12345",
    "dataStatus": {
      "dataPoints": {},
      "documents": {}
    },
    "metadata": {}
  },
  "company": {
    "id": "932884117",
    "countryCode": "FR",
    "identifiers": {
      "VAT": "02580590541",
      "Codice Fiscale": "RSSMRA70A01H501U",
      "CCIAA": "TO",
      "REA Code": "1234567"
    },
    "legalName": "Topograph",
    "legalNameInEnglish": "Test Display Hong Kong Trading Limited",
    "commercialNames": [
      "Topograph",
      "TopographHQ"
    ],
    "legacyLegalNames": [
      "Semaphore",
      "SemaphoreHQ"
    ],
    "legacyCommercialNames": [
      "Semaphore",
      "SemaphoreHQ"
    ],
    "status": {
      "localName": "active",
      "active": true,
      "statusDetailsBeta": {
        "status": "ACTIVE",
        "closureReason": "BANKRUPTCY",
        "closureDate": "2024-01-15",
        "insolvencyStartDate": "2023-12-01",
        "additionalInfo": "Company entered voluntary liquidation due to retirement of owner"
      }
    },
    "registrationDate": "2024-04-22",
    "incorporationDate": "2024-04-15",
    "legalForm": {
      "localName": "EURL, entreprise unipersonnelle à responsabilité limitée",
      "englishTranslation": "Single Member Limited Liability Company",
      "semaphoreStandard": "Limited Liability Company",
      "standardized": "Limited Liability Company",
      "iso20275Code": "F8DD"
    },
    "capital": {
      "amount": 1000,
      "currency": "EUR",
      "formatted": "1000.00 €"
    },
    "activities": {
      "NACE": [
        {
          "code": "62.01",
          "description": "Computer programming activities"
        }
      ],
      "ISIC": [
        {
          "code": "J620",
          "description": "Computer programming, consultancy and related activities"
        }
      ]
    },
    "activityDescription": "Development of software solutions and IT consulting services",
    "legalAddress": {
      "addressLine1": "10 rue de la Fraternité",
      "city": "Bagnolet",
      "postalCode": "93170",
      "region": "FR",
      "countryCode": "FR",
      "state": "Île-de-France",
      "addressLine2": "Topograph Building",
      "poBox": "PO Box 123",
      "careOf": "c/o John Doe"
    },
    "phones": [
      "+33123456789",
      "+33987654321"
    ],
    "website": "https://www.example.com",
    "employeeCount": {
      "exact": 150,
      "min": 100,
      "max": 200,
      "lastUpdated": "2024-03-15",
      "isEstimate": false
    }
  },
  "ultimateBeneficialOwners": [
    {
      "gender": "Female",
      "name": {
        "fullName": "John Doe"
      },
      "birthDate": {
        "day": 15,
        "month": 7,
        "year": 1980
      },
      "birthAddress": {
        "country": "FR",
        "city": "Paris",
        "street": "1 Rue de Rivoli",
        "postalCode": "75001"
      },
      "nationality": "US",
      "residenceAddress": {
        "addressLine1": "10 rue de la Fraternité",
        "city": "Bagnolet",
        "postalCode": "93170",
        "region": "FR",
        "countryCode": "FR",
        "state": "Île-de-France",
        "addressLine2": "Topograph Building",
        "poBox": "PO Box 123",
        "careOf": "c/o John Doe"
      },
      "control": {
        "controlType": "ownership-of-shares",
        "description": "The person holds more than 50% of the shares in the company.",
        "percentageDetails": [
          {
            "type": "shares",
            "range": {
              "lower": 50,
              "upper": 75
            }
          }
        ],
        "additionalDetails": "Direct ownership of shares"
      },
      "identifiers": [
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "entityId": "person_001"
    }
  ],
  "legalRepresentatives": [
    {
      "type": "individual",
      "entityId": "person_001",
      "role": {
        "standardized": "Director",
        "localName": "Directeur",
        "englishTranslation": "Director",
        "iso5009Code": "GIDXNF",
        "semaphoreStandard": "Director"
      },
      "startDate": "2022-01-01",
      "endDate": "2023-12-31",
      "individual": {
        "gender": "Female",
        "name": {
          "fullName": "John Doe"
        },
        "birthDate": {
          "day": 15,
          "month": 7,
          "year": 1980
        },
        "birthAddress": {
          "country": "FR",
          "city": "Paris",
          "street": "1 Rue de Rivoli",
          "postalCode": "75001"
        },
        "nationality": "US",
        "residenceAddress": {
          "addressLine1": "10 rue de la Fraternité",
          "city": "Bagnolet",
          "postalCode": "93170",
          "region": "FR",
          "countryCode": "FR",
          "state": "Île-de-France",
          "addressLine2": "Topograph Building",
          "poBox": "PO Box 123",
          "careOf": "c/o John Doe"
        },
        "identifiers": [
          {
            "type": "<string>",
            "value": "<string>"
          }
        ]
      },
      "company": {
        "id": "932884117",
        "countryCode": "FR",
        "identifiers": {
          "VAT": "02580590541",
          "Codice Fiscale": "RSSMRA70A01H501U",
          "CCIAA": "TO",
          "REA Code": "1234567"
        },
        "legalName": "Topograph",
        "legalNameInEnglish": "Test Display Hong Kong Trading Limited",
        "commercialNames": [
          "Topograph",
          "TopographHQ"
        ],
        "legacyLegalNames": [
          "Semaphore",
          "SemaphoreHQ"
        ],
        "legacyCommercialNames": [
          "Semaphore",
          "SemaphoreHQ"
        ],
        "status": {
          "localName": "active",
          "active": true,
          "statusDetailsBeta": {
            "status": "ACTIVE",
            "closureReason": "BANKRUPTCY",
            "closureDate": "2024-01-15",
            "insolvencyStartDate": "2023-12-01",
            "additionalInfo": "Company entered voluntary liquidation due to retirement of owner"
          }
        },
        "registrationDate": "2024-04-22",
        "incorporationDate": "2024-04-15",
        "legalForm": {
          "localName": "EURL, entreprise unipersonnelle à responsabilité limitée",
          "englishTranslation": "Single Member Limited Liability Company",
          "semaphoreStandard": "Limited Liability Company",
          "standardized": "Limited Liability Company",
          "iso20275Code": "F8DD"
        },
        "capital": {
          "amount": 1000,
          "currency": "EUR",
          "formatted": "1000.00 €"
        },
        "activities": {
          "NACE": [
            {
              "code": "62.01",
              "description": "Computer programming activities"
            }
          ],
          "ISIC": [
            {
              "code": "J620",
              "description": "Computer programming, consultancy and related activities"
            }
          ]
        },
        "activityDescription": "Development of software solutions and IT consulting services",
        "legalAddress": {
          "addressLine1": "10 rue de la Fraternité",
          "city": "Bagnolet",
          "postalCode": "93170",
          "region": "FR",
          "countryCode": "FR",
          "state": "Île-de-France",
          "addressLine2": "Topograph Building",
          "poBox": "PO Box 123",
          "careOf": "c/o John Doe"
        },
        "phones": [
          "+33123456789",
          "+33987654321"
        ],
        "website": "https://www.example.com",
        "employeeCount": {
          "exact": 150,
          "min": 100,
          "max": 200,
          "lastUpdated": "2024-03-15",
          "isEstimate": false
        }
      },
      "representedBy": {
        "gender": "Female",
        "name": {
          "fullName": "John Doe"
        },
        "birthDate": {
          "day": 15,
          "month": 7,
          "year": 1980
        },
        "birthAddress": {
          "country": "FR",
          "city": "Paris",
          "street": "1 Rue de Rivoli",
          "postalCode": "75001"
        },
        "nationality": "US",
        "residenceAddress": {
          "addressLine1": "10 rue de la Fraternité",
          "city": "Bagnolet",
          "postalCode": "93170",
          "region": "FR",
          "countryCode": "FR",
          "state": "Île-de-France",
          "addressLine2": "Topograph Building",
          "poBox": "PO Box 123",
          "careOf": "c/o John Doe"
        },
        "identifiers": [
          {
            "type": "<string>",
            "value": "<string>"
          }
        ]
      }
    }
  ],
  "shareholders": [
    {
      "type": "individual",
      "entityId": "person_001",
      "individual": {
        "gender": "Female",
        "name": {
          "fullName": "John Doe"
        },
        "birthDate": {
          "day": 15,
          "month": 7,
          "year": 1980
        },
        "birthAddress": {
          "country": "FR",
          "city": "Paris",
          "street": "1 Rue de Rivoli",
          "postalCode": "75001"
        },
        "nationality": "US",
        "residenceAddress": {
          "addressLine1": "10 rue de la Fraternité",
          "city": "Bagnolet",
          "postalCode": "93170",
          "region": "FR",
          "countryCode": "FR",
          "state": "Île-de-France",
          "addressLine2": "Topograph Building",
          "poBox": "PO Box 123",
          "careOf": "c/o John Doe"
        },
        "identifiers": [
          {
            "type": "<string>",
            "value": "<string>"
          }
        ]
      },
      "company": {
        "id": "932884117",
        "countryCode": "FR",
        "identifiers": {
          "VAT": "02580590541",
          "Codice Fiscale": "RSSMRA70A01H501U",
          "CCIAA": "TO",
          "REA Code": "1234567"
        },
        "legalName": "Topograph",
        "legalNameInEnglish": "Test Display Hong Kong Trading Limited",
        "commercialNames": [
          "Topograph",
          "TopographHQ"
        ],
        "legacyLegalNames": [
          "Semaphore",
          "SemaphoreHQ"
        ],
        "legacyCommercialNames": [
          "Semaphore",
          "SemaphoreHQ"
        ],
        "status": {
          "localName": "active",
          "active": true,
          "statusDetailsBeta": {
            "status": "ACTIVE",
            "closureReason": "BANKRUPTCY",
            "closureDate": "2024-01-15",
            "insolvencyStartDate": "2023-12-01",
            "additionalInfo": "Company entered voluntary liquidation due to retirement of owner"
          }
        },
        "registrationDate": "2024-04-22",
        "incorporationDate": "2024-04-15",
        "legalForm": {
          "localName": "EURL, entreprise unipersonnelle à responsabilité limitée",
          "englishTranslation": "Single Member Limited Liability Company",
          "semaphoreStandard": "Limited Liability Company",
          "standardized": "Limited Liability Company",
          "iso20275Code": "F8DD"
        },
        "capital": {
          "amount": 1000,
          "currency": "EUR",
          "formatted": "1000.00 €"
        },
        "activities": {
          "NACE": [
            {
              "code": "62.01",
              "description": "Computer programming activities"
            }
          ],
          "ISIC": [
            {
              "code": "J620",
              "description": "Computer programming, consultancy and related activities"
            }
          ]
        },
        "activityDescription": "Development of software solutions and IT consulting services",
        "legalAddress": {
          "addressLine1": "10 rue de la Fraternité",
          "city": "Bagnolet",
          "postalCode": "93170",
          "region": "FR",
          "countryCode": "FR",
          "state": "Île-de-France",
          "addressLine2": "Topograph Building",
          "poBox": "PO Box 123",
          "careOf": "c/o John Doe"
        },
        "phones": [
          "+33123456789",
          "+33987654321"
        ],
        "website": "https://www.example.com",
        "employeeCount": {
          "exact": 150,
          "min": 100,
          "max": 200,
          "lastUpdated": "2024-03-15",
          "isEstimate": false
        }
      },
      "sharePercentage": 25.5,
      "numberOfShares": 1000,
      "nominalCapitalHeld": {
        "amount": 1000,
        "currency": "EUR",
        "formatted": "1000.00 €"
      },
      "paidInAmount": {
        "amount": 1000,
        "currency": "EUR",
        "formatted": "1000.00 €"
      }
    }
  ],
  "establishments": [
    {
      "name": "Main Office",
      "id": "EST-001",
      "creationDate": "2020-01-15",
      "endDate": "2023-12-31",
      "active": true,
      "address": {
        "addressLine1": "10 rue de la Fraternité",
        "city": "Bagnolet",
        "postalCode": "93170",
        "region": "FR",
        "countryCode": "FR",
        "state": "Île-de-France",
        "addressLine2": "Topograph Building",
        "poBox": "PO Box 123",
        "careOf": "c/o John Doe"
      }
    }
  ],
  "otherKeyPersons": [
    {
      "type": "individual",
      "entityId": "person_001",
      "role": {
        "standardized": "Board Member",
        "localName": "Commissaire aux comptes",
        "englishTranslation": "Auditor",
        "semaphoreStandard": "Board Member"
      },
      "startDate": "2022-01-01",
      "endDate": "2023-12-31",
      "individual": {
        "gender": "Female",
        "name": {
          "fullName": "John Doe"
        },
        "birthDate": {
          "day": 15,
          "month": 7,
          "year": 1980
        },
        "birthAddress": {
          "country": "FR",
          "city": "Paris",
          "street": "1 Rue de Rivoli",
          "postalCode": "75001"
        },
        "nationality": "US",
        "residenceAddress": {
          "addressLine1": "10 rue de la Fraternité",
          "city": "Bagnolet",
          "postalCode": "93170",
          "region": "FR",
          "countryCode": "FR",
          "state": "Île-de-France",
          "addressLine2": "Topograph Building",
          "poBox": "PO Box 123",
          "careOf": "c/o John Doe"
        },
        "identifiers": [
          {
            "type": "<string>",
            "value": "<string>"
          }
        ]
      },
      "company": {
        "id": "932884117",
        "countryCode": "FR",
        "identifiers": {
          "VAT": "02580590541",
          "Codice Fiscale": "RSSMRA70A01H501U",
          "CCIAA": "TO",
          "REA Code": "1234567"
        },
        "legalName": "Topograph",
        "legalNameInEnglish": "Test Display Hong Kong Trading Limited",
        "commercialNames": [
          "Topograph",
          "TopographHQ"
        ],
        "legacyLegalNames": [
          "Semaphore",
          "SemaphoreHQ"
        ],
        "legacyCommercialNames": [
          "Semaphore",
          "SemaphoreHQ"
        ],
        "status": {
          "localName": "active",
          "active": true,
          "statusDetailsBeta": {
            "status": "ACTIVE",
            "closureReason": "BANKRUPTCY",
            "closureDate": "2024-01-15",
            "insolvencyStartDate": "2023-12-01",
            "additionalInfo": "Company entered voluntary liquidation due to retirement of owner"
          }
        },
        "registrationDate": "2024-04-22",
        "incorporationDate": "2024-04-15",
        "legalForm": {
          "localName": "EURL, entreprise unipersonnelle à responsabilité limitée",
          "englishTranslation": "Single Member Limited Liability Company",
          "semaphoreStandard": "Limited Liability Company",
          "standardized": "Limited Liability Company",
          "iso20275Code": "F8DD"
        },
        "capital": {
          "amount": 1000,
          "currency": "EUR",
          "formatted": "1000.00 €"
        },
        "activities": {
          "NACE": [
            {
              "code": "62.01",
              "description": "Computer programming activities"
            }
          ],
          "ISIC": [
            {
              "code": "J620",
              "description": "Computer programming, consultancy and related activities"
            }
          ]
        },
        "activityDescription": "Development of software solutions and IT consulting services",
        "legalAddress": {
          "addressLine1": "10 rue de la Fraternité",
          "city": "Bagnolet",
          "postalCode": "93170",
          "region": "FR",
          "countryCode": "FR",
          "state": "Île-de-France",
          "addressLine2": "Topograph Building",
          "poBox": "PO Box 123",
          "careOf": "c/o John Doe"
        },
        "phones": [
          "+33123456789",
          "+33987654321"
        ],
        "website": "https://www.example.com",
        "employeeCount": {
          "exact": 150,
          "min": 100,
          "max": 200,
          "lastUpdated": "2024-03-15",
          "isEstimate": false
        }
      }
    }
  ],
  "graph": {},
  "documents": {
    "tradeRegisterExtract": {
      "id": "<string>",
      "name": "<string>",
      "format": "<string>",
      "description": "<string>",
      "estimatedDeliverySeconds": 123,
      "url": "<string>",
      "pdfUrl": "<string>",
      "blobName": "<string>",
      "price": 123,
      "priceMarkup": 123,
      "date": "<string>"
    },
    "certifiedTradeRegisterExtract": {
      "id": "<string>",
      "name": "<string>",
      "format": "<string>",
      "description": "<string>",
      "estimatedDeliverySeconds": 123,
      "url": "<string>",
      "pdfUrl": "<string>",
      "blobName": "<string>",
      "price": 123,
      "priceMarkup": 123,
      "date": "<string>"
    },
    "financialStatements": [
      {
        "id": "<string>",
        "name": "<string>",
        "format": "<string>",
        "description": "<string>",
        "estimatedDeliverySeconds": 123,
        "url": "<string>",
        "pdfUrl": "<string>",
        "blobName": "<string>",
        "price": 123,
        "priceMarkup": 123,
        "date": "<string>",
        "period": {
          "startDate": {
            "year": 123,
            "month": 123,
            "day": 123
          },
          "endDate": {
            "year": 123,
            "month": 123,
            "day": 123
          }
        }
      }
    ],
    "articlesOfAssociation": [
      {
        "id": "<string>",
        "name": "<string>",
        "format": "<string>",
        "description": "<string>",
        "estimatedDeliverySeconds": 123,
        "url": "<string>",
        "pdfUrl": "<string>",
        "blobName": "<string>",
        "price": 123,
        "priceMarkup": 123,
        "date": "<string>"
      }
    ],
    "ultimateBeneficialOwnersCertificate": [
      {
        "id": "<string>",
        "name": "<string>",
        "format": "<string>",
        "description": "<string>",
        "estimatedDeliverySeconds": 123,
        "url": "<string>",
        "pdfUrl": "<string>",
        "blobName": "<string>",
        "price": 123,
        "priceMarkup": 123,
        "date": "<string>"
      }
    ],
    "lastFiscalYearFinancialStatement": {
      "id": "<string>",
      "name": "<string>",
      "format": "<string>",
      "description": "<string>",
      "estimatedDeliverySeconds": 123,
      "url": "<string>",
      "pdfUrl": "<string>",
      "blobName": "<string>",
      "price": 123,
      "priceMarkup": 123,
      "date": "<string>"
    },
    "officialPublications": [
      {
        "id": "<string>",
        "name": "<string>",
        "format": "<string>",
        "description": "<string>",
        "estimatedDeliverySeconds": 123,
        "url": "<string>",
        "pdfUrl": "<string>",
        "blobName": "<string>",
        "price": 123,
        "priceMarkup": 123,
        "date": "<string>"
      }
    ],
    "otherDocuments": [
      {
        "id": "<string>",
        "name": "<string>",
        "format": "<string>",
        "description": "<string>",
        "estimatedDeliverySeconds": 123,
        "url": "<string>",
        "pdfUrl": "<string>",
        "blobName": "<string>",
        "price": 123,
        "priceMarkup": 123,
        "date": "<string>"
      }
    ]
  },
  "companyRelationships": [
    {
      "relation": "mergedFrom",
      "company": {
        "id": "932884117",
        "countryCode": "FR",
        "identifiers": {
          "VAT": "02580590541",
          "Codice Fiscale": "RSSMRA70A01H501U",
          "CCIAA": "TO",
          "REA Code": "1234567"
        },
        "legalName": "Topograph",
        "legalNameInEnglish": "Test Display Hong Kong Trading Limited",
        "commercialNames": [
          "Topograph",
          "TopographHQ"
        ],
        "legacyLegalNames": [
          "Semaphore",
          "SemaphoreHQ"
        ],
        "legacyCommercialNames": [
          "Semaphore",
          "SemaphoreHQ"
        ],
        "status": {
          "localName": "active",
          "active": true,
          "statusDetailsBeta": {
            "status": "ACTIVE",
            "closureReason": "BANKRUPTCY",
            "closureDate": "2024-01-15",
            "insolvencyStartDate": "2023-12-01",
            "additionalInfo": "Company entered voluntary liquidation due to retirement of owner"
          }
        },
        "registrationDate": "2024-04-22",
        "incorporationDate": "2024-04-15",
        "legalForm": {
          "localName": "EURL, entreprise unipersonnelle à responsabilité limitée",
          "englishTranslation": "Single Member Limited Liability Company",
          "semaphoreStandard": "Limited Liability Company",
          "standardized": "Limited Liability Company",
          "iso20275Code": "F8DD"
        },
        "capital": {
          "amount": 1000,
          "currency": "EUR",
          "formatted": "1000.00 €"
        },
        "activities": {
          "NACE": [
            {
              "code": "62.01",
              "description": "Computer programming activities"
            }
          ],
          "ISIC": [
            {
              "code": "J620",
              "description": "Computer programming, consultancy and related activities"
            }
          ]
        },
        "activityDescription": "Development of software solutions and IT consulting services",
        "legalAddress": {
          "addressLine1": "10 rue de la Fraternité",
          "city": "Bagnolet",
          "postalCode": "93170",
          "region": "FR",
          "countryCode": "FR",
          "state": "Île-de-France",
          "addressLine2": "Topograph Building",
          "poBox": "PO Box 123",
          "careOf": "c/o John Doe"
        },
        "phones": [
          "+33123456789",
          "+33987654321"
        ],
        "website": "https://www.example.com",
        "employeeCount": {
          "exact": 150,
          "min": 100,
          "max": 200,
          "lastUpdated": "2024-03-15",
          "isEstimate": false
        }
      },
      "effectiveDate": "<string>",
      "description": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
id
string
required

The company id. In some countries, this might be a concatenation of the registry and city (e.g., in Germany: "Augsburg HRB 34617"). The search function will always return a usable company number. Check the documentation to see which number format is used for each country.

Example:

"932884117"

​
countryCode
enum<string>
required

The country code in ISO 3166-1 alpha-2 format (e.g., "FR" for France, "DE" for Germany).

Available options:
AT,
BE,
CH,
CN,
CZ,
CY,
DE,
DK,
EE,
ES,
FI,
FR,
GB,
GG,
HK,
HR,
HU,
IE,
IT,
JE,
LI,
LU,
LV,
MC,
MT,
MU,
NL,
NO,
PL,
PT,
RO,
SE,
SK,
VG
Example:

"FR"

​
dataPoints
enum<string>[]

The data points to retrieve. Only companyProfile is supported for onboarding.

Available options:
companyProfile
Example:
["companyProfile"]
​
metadata
object

Arbitrary key-value string pairs to associate with the request. Limits: max 50 keys, keys up to 40 chars (longer keys are skipped), values up to 500 chars (longer values are truncated).

Response

200 - application/json

Company onboarding information

​
request
object
required

The request

​
company
object
required

The main profile information of the company, including, if available, details such as name, registration number, address, and other core data.

​
ultimateBeneficialOwners
object[]

The persons of significant control of the company, including, if available, their name, nationality, and other relevant details.

​
legalRepresentatives
object[]

The legal representatives of the company, which can be either individuals or companies.

​
shareholders
object[]

The shareholders of the company, which can be either individuals or companies.

​
establishments
object[]

The establishments of the company, including physical locations where business activities are conducted.

​
otherKeyPersons
object[]

Other key persons associated with the company who do not have legal signing authority, such as board members, auditors, and compliance officers.

​
graph
object
​
documents
object
​
companyRelationships
object[]