> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cocoondata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# <access-service>/api/v1/users/import

## URL structure&#x20;

```text theme={null}
https://access-service.xy-company.com/api/v1/users/import
```

## Supported methods and overview&#x20;

* `POST` - used to add new [Covata users](/3.0/admin/administering-users.md) [in bulk (through a CSV file)](/3.0/admin/administering-users.md#adding-new-users-in-bulk-from-csv).

## Detailed description&#x20;

> [!NOTE]
>
> The content in this section of the page (and after **Required Headers** below) is incomplete and will be completed in due course.

## Supported roles&#x20;

This API endpoint supports the following Covata user [roles](/3.0/admin/administering-users.md#a-users-roles) (as described in the [Covata Platform Administrator's Guide](/3.0/admin.md)):

* [System administrator](/3.0/admin/administering-users.md#system-administrator-role)

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the [header](/3.0/api/access-service-api-v1-users-import.md#access-service-api-v1-users-import-required-headers) of requests to this endpoint.

## Required headers&#x20;

The appropriate access token as the `Bearer` token:

* `Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6`

The following header is also required in a POST request to allow multi-part (including binary) form data elements to be uploaded through the request:

* `Content-Type: multipart/form-data`

> [!NOTE]
>
> It is also worth appending to this header a `boundary` parameter, whose string value is used to demark each multi-part form data element of the request (i.e. this string is not used for any other purpose throughout the entire request). \\
>
> For example, to use the following string to demark each multi-part form data element: \\
>
> `-----------------------------12345678901234567890123456` \\
>
> assign this string value to the `boundary` parameter, which in turn is appended to the `Content-Type: multipart/form-data` header, such that this header will be: \\
>
> `Content-Type: multipart/form-data; boundary=-----------------------------12345678901234567890123456`

## Required parameters&#x20;

The following required parameter must be sent in the body of the POST request, as an individual multi-part form data element:

* **file** - The actual data of the CSV file to be uploaded to the Covata Platform's Access Service. See [Adding new users in bulk (from CSV)](/3.0/admin/administering-users.md#adding-new-users-in-bulk-from-csv) in the [Covata Platform Administrator's Guide](/3.0/admin.md) for more information about the preparation and requirements for your CSV file.

  **Example ():**

## Returns&#x20;

A JSON-formatted response containing the following members:

* **success** - .
* **message** - .
* **errors** - An array of strings, each one describing an error encountered when importing a new Covata user to the Covata Platform from the CSV file.

  **Example ():**


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.