Input user

The user input allows adding or modifying information for a data type (officer, BeneficialOwner, etc.).

Endpoints

POST

/api/v6/input/users/{userId}/{data-types}

Example request body:

{
  "data-type_id": "string",
  "file": "file (base64)",
  "data": {
    ...data-type-body
  }
}

Field	Type	Description
data-type_id	string (optional)	Unique identifier of the data-type.
file	string (optional) (Binary file encoded in base64)	File associated with.
data	object	Link to documentation

danger

If you want to modify the information of a data type, you must provide its data-type_id. If you want to add a new one, you should ignore it.

PUT

With this endpoint, you can only modify a data type created through input.

/api/v6/input/users/{userId}/{data-types}/{dataTypeInputId}

Example request body:

{
  "data-type_id": "string",
  "file": "file (base64)",
  "data": {
    ...data-type-body
  }
}

dataTypeInputId: The ID of the input, which you can find in the response of the POST request.

GET

/api/v6/input/users/{userId}/{data-types}

Example response:

{
  "total": 0,
  "per_page": 0,
  "current_page": 0,
  "last_page": 0,
  "result": [
    {
        "data-type_id": "string",
        "file": "file (base64)",
        "data": {
          ...data-type-body
        }
    }
  ]
}

info

You can find all the endpoints in this documentation: API Documentation.

Available DataTypes

• COMPANY_OFFICER
• BENEFICIAL_OWNER
• TAX_RETURN

To retrieve this data in the corresponding dataTypes, you need to activate the input_user provider, create a dataConnection and synchronize.

Example for Officers:

Officer

This endpoint allows creating or updating an officer's information for a specific user.

URL

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

Path Parameters

• userId (string, required): The unique identifier of the user.

Request Body

{
  "officer_id": "string",
  "file": "string" (Binary file encoded in 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"
          }
        ]
      }
    ]
  }
}

Field Descriptions

Field	Type	Description
officer_id	string (optional)	Unique identifier of the officer.
file	string (optional) (Binary file encoded in base64)	File associated with the officer.
data	object	Link to documentation