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

# Migrate Documents Status

Use this API to poll the status of a document migration. Use the `migrationId` returned from the [Migrate Documents](https://velt.dev/docs/api-reference/rest-apis/v2/documents/migrate-documents.md) endpoint.

# Endpoint

`POST https://api.velt.dev/v2/organizations/documents/migrate/status`

# Headers

**x-velt-api-key** `string` *required*

Your API key.

**x-velt-auth-token** `string` *required*

Your [Auth Token](https://velt.dev/docs/security/auth-tokens.md).

# Body

#### Params

**data** `object` *required*

**properties**

**organizationId** `string` *required*

Organization ID

**migrationId** `string` *required*

Migration ID returned from the [Migrate Documents](https://velt.dev/docs/api-reference/rest-apis/v2/documents/migrate-documents.md) endpoint

## **Example Requests**

#### Check migration status

```JSON theme={null}
{
  "data": {
    "organizationId": "yourOrganizationId",
    "migrationId": "yourMigrationId"
  }
}
```

# Response

#### Success Response

The `status` field reflects the current state of the migration. Possible values: `pending`, `in_progress`, `completed`, `failed`.

```JSON theme={null}
{
  "result": {
    "status": "success",
    "message": "Migration status retrieved successfully.",
    "data": {
      "migrationId": "yourMigrationId",
      "status": "completed"
    }
  }
}
```

#### Failure Response

```JSON theme={null}
{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}
```

```js theme={null}
{
  "result": {
    "status": "success",
    "message": "Migration status retrieved successfully.",
    "data": {
      "migrationId": "yourMigrationId",
      "status": "completed"
    }
  }
}
```


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