# Packages API Reference

> Source: https://centric-api-docs.certn.co/#packages

Packages are pre-configured sets of Checks that can be used to standardize Case ordering.


## Endpoints

| Method | Path | Description |
|--------|------|-------------|
| `GET` | `/api/public/packages/` |  |
| `POST` | `/api/public/packages/activate/` |  |
| `POST` | `/api/public/packages/create/` |  |
| `POST` | `/api/public/packages/deactivate/` |  |

### GET /api/public/packages/

#### Parameters

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `is_active` | query | boolean | No |  |
| `page` | query | integer | No | A page number within the paginated result set. |
| `page_size` | query | integer | No | Number of results to return per page. Defaults to 10, maximum 100. |
| `permissible_purposes` | query | array | No | * `EMPLOYMENT` - Employment (HR)
* `TENANCY` - Tenancy (PM)
* `INVESTING` - Investing
* `INSURANCE` - Insurance
* `LENDING` - Lending
* `CONSUMER` - As directed by consumer |

#### Example Request

```bash
curl -X GET "https://api.sandbox.certn.co/api/public/packages/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

### POST /api/public/packages/activate/

Activate a package.

#### Example Request

```bash
curl -X POST "https://api.sandbox.certn.co/api/public/packages/activate/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

### POST /api/public/packages/create/

This endpoint allows you to create a package.  A package is a predefined configuration
of checks that can be ordered.

Ensure you have familiarized yourself with the concepts under `Settings > Integrations > Documentation > Introduction`.

#### Example Request

```bash
curl -X POST "https://api.sandbox.certn.co/api/public/packages/create/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

### POST /api/public/packages/deactivate/

Deactivate a package.

#### Example Request

```bash
curl -X POST "https://api.sandbox.certn.co/api/public/packages/deactivate/" \
  -H "Authorization: Api-Key YOUR_API_KEY"
```

---

*See the [interactive documentation](https://centric-api-docs.certn.co/#packages) for more details.*