Skip to main content

RelatedCorporate

iduuidrequired

Unique identifier of the related corporate entity

namestringrequired

Registered legal name of the corporate entity

relationshipstringrequired

The relationship of the corporate entity to the business being onboarded

Possible values: [PARENT, SUBSIDIARY]

percentageOwneddoublerequired

Percentage of shares owned

documents object[]required

A list of documents associated with the corporate entity

  • Array [
    • iduuidrequired
    titlestringrequired
    descriptionstringrequired
    statusstringrequired

    Possible values: [NOT_SUBMITTED, PENDING_REVIEW, DECLINED, APPROVED, PENDING_VERIFICATION, VALIDATION_WARNINGS]

    requiredbooleanrequired
    expiresAtdate-time
    declinedReasonstring

    Possible values: [NOT_CERTIFIED, INVALID_DOCUMENT_TYPE, QUALITY, OTHER_SEE_SUPPORT]

    declinedCustomerDisplayReasonstring
    validationStatusstring

    When status is VALIDATION_WARNINGS, the specific warning category from automated document review.

    Possible values: [WARNING_NOT_CERTIFIED, WARNING_SUSPECTED_INVALID_DOCUMENT_TYPE, WARNING_QUALITY_INSUFFICIENT, WARNING_EXPIRED_DOCUMENT, WARNING_EXPIRING_DOCUMENT, WARNING_OTHER, WARNING_REQUIRED_FIELDS_MISSING, CRITICAL_CERTAIN_INVALID_DOCUMENT_TYPE, CRITICAL_DOCUMENT_UNREADABLE, CRITICAL_OTHER]

    validationMessagestring

    When status is VALIDATION_WARNINGS, a human-readable warning message safe to show the end customer.

    lastUpdatedBystring
    lastUpdatedAtdate-time
    documentUploads object[]required
  • Array [
    • iduuidrequired
    fileNamestringrequired
    contentTypestringrequired
    createdAtdate-timerequired
  • ]
    • documentTypestringrequired

    The type of corporate document.

    • TRADE_LICENSE: The corporate entity's trade licence. Required for PARENT relationships.
    • MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION: Required for PARENT relationships. Becomes optional if a Shareholding Certificate is attached.
    • SHAREHOLDING_CERTIFICATE: Optional for PARENT relationships.

    Possible values: [TRADE_LICENSE, MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION, SHAREHOLDING_CERTIFICATE]

  • ]
    • createdAtdate-timerequired

    Timestamp when the corporate entity was added

    RelatedCorporate
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "relationship": "PARENT",
      "percentageOwned": 0,
      "documents": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string",
          "description": "string",
          "status": "NOT_SUBMITTED",
          "required": true,
          "expiresAt": "2024-07-29T15:51:28.071Z",
          "declinedReason": "NOT_CERTIFIED",
          "declinedCustomerDisplayReason": "string",
          "validationStatus": "WARNING_NOT_CERTIFIED",
          "validationMessage": "string",
          "lastUpdatedBy": "string",
          "lastUpdatedAt": "2024-07-29T15:51:28.071Z",
          "documentUploads": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "fileName": "string",
              "contentType": "string",
              "createdAt": "2024-07-29T15:51:28.071Z"
            }
          ],
          "documentType": "TRADE_LICENSE"
        }
      ],
      "createdAt": "2024-07-29T15:51:28.071Z"
    }