Skip to main content

Input user

The input_user allows for adding or modifying information for a data type (e.g., Officer, Beneficial Owner, etc.).

Supported Data Types​

This provider supports the following data types:

Connect Your Input User​

To modify or add data for beneficial owners or company officers, you need to connect the Company_legal_fr connector (Company and Officer Information). Here’s how to set it up:

  1. Ensure the Company_legal_fr connector is connected and synchronized.
  2. Use the Input_user connector to add or modify data for beneficial owners or company officers.
  3. Perform a synchronization to apply the changes.

Add Beneficial Owners​

You can add or update beneficial ownership data manually, including associated PDF files (base64). Follow these steps:

Step 1: Create a new beneficial ownership declaration​

Use the following endpoint to create a declaration with the desired details:

Endpoint:
POST /api/v6/input/users/{userId}/beneficial-owners

Request Body:

{
  "beneficial_owner_declaration_id": "string",
  "data": {
    "file": "file (base64)",
    "document_date": "2021-05-19",
    "date": "2021-05-19",
    "beneficial_owners": [
      {
        "start_date": "2021-05-19",
        "end_date": "2021-05-19",
        "is_legal_representative": true,
        "type": "string",
        "last_name": "string",
        "patronym": "string",
        "first_name": "string",
        "nationality": "string",
        "birth_date": "2021-05-19",
        "birth_city": "string",
        "birth_country": "string",
        "address": {
          "address_line1": "string",
          "address_line2": "string",
          "city": "string",
          "postal_code": "string"
        },
        "total_owned_parts": "string",
        "direct_owned_part": "string",
        "indirect_owned_part": "string",
        "indirect_part_pm": "string",
        "total_vote": "string",
        "direct_vote": "string",
        "indirect_vote": "string",
        "indirect_vote_pm": "string"
      }
    ]
  }
}

Step 2: Create a data connection for beneficial owners​

POST /api/v6/users/{userId}/data-connections

Request Body:

{
  "requested_data_types": ["BENEFICIAL_OWNER"],
  "provider_name": "input_user"
}

Step 3: Synchronize beneficial ownership data​

POST /api/v6/users/{userId}/sync

Request Body:

{
  "data_types": ["BENEFICIAL_OWNER"]
}

Add or Modify Company Officers​

You can create or update company officer records, including uploading identification files. Follow these steps:

Step 1: Create or modify a company officer​

Use the following endpoint for creating or modifying a company officer. If updating, include the officer_id field.

Endpoint:
POST /api/v6/input/users/{userId}/company-officers

Request Body:

{
  "officer_id": "string",
  "file": "file (base64)",
  "data": {
    "last_name": "string",
    "patronym": "string",
    "first_name": "string",
    "birth_date": "2021-05-19",
    "birth_city": "string",
    "birth_country": "string",
    "birth_postal_code": "string",
    "nationality": "string",
    "name": "string",
    "siren": "string",
    "type": "string",
    "address": {
      "address_line1": "string",
      "address_line2": "string",
      "city": "string",
      "postal_code": "string",
      "country": "string"
    },
    "companies": [
      {
        "name": "string",
        "siren": "string",
        "roles": [
          {
            "name": "string",
            "start_date": "2021-05-19",
            "end_date": "2021-05-19"
          }
        ]
      }
    ]
  }
}

Step 2: Create a data connection for company officers​

POST /api/v6/users/{userId}/data-connections

Request Body:

{
  "data_types": ["COMPANY_OFFICER"]
}

Step 3: Synchronize company officer data​

POST /api/v6/users/{userId}/sync

Request Body:

{
  "data_types": ["COMPANY_OFFICER"]
}

Update Existing Data​

Beneficial Ownership Declarations​

PUT /api/v6/input/users/{userId}/beneficial-owners/{declarationInputId}

Company Officers​

PUT /api/v6/input/users/{userId}/company-officers/{officerInputId}

Delete Existing Data​

Beneficial Ownership Declarations​

DELETE /api/v6/input/users/{userId}/beneficial-owners/{declarationInputId}

Company Officers​

DELETE /api/v6/input/users/{userId}/company-officers/{officerInputId}

Notes​

  • Monitoring Limitations:
    • Monitoring of beneficial owners and officers created through 'Input_user' cannot be monitored. .
    • Company officers created or modified via the Input_user connector cannot be monitored.

To verify that you are receiving the right data, check out these endpoints:

  • GET /api/v6/users/{userId}/company-officers
  • GET /api/v6/users/{userId}/beneficial-owners