# Redkik userservice API

> Redkik userservice API on Apizie: 60 endpoints (POST /api/v2/user/api-tokens, DELETE /api/v2/user/api-tokens/{id}, Fetches audits in batches set by perPage (default 20). Should be used mainly from UI., POST /api/v2/user/audits, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/ecommerce:redkik/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:redkik`
- Category: E-commerce
- Status: byok
- Source: https://redkik.com
- Page: https://zieapi.vercel.app/api/ecommerce/redkik
- OpenAPI: https://zieapi.vercel.app/api/ecommerce/redkik/openapi.json

Redkik is a global InsurTech company with the mission to transform and improve the insurance industry for all parties within logistics and transportation. Redkik's innovative software eliminates the need for annual and…

## Endpoints

### POST /api/v2/user/api-tokens
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/api-token-controller-create-user-api-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### DELETE /api/v2/user/api-tokens/{id}
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/api-token-controller-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Fetches audits in batches set by perPage (default 20). Should be used mainly from UI.
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/audit-controller-get-audits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | Index of page |
| perPage | number | no | Page size |
| globalFilter | string | no | Global filter of filterable fields |
| order | object | no | Stringified TypeOrm order |
| where | array | no | Stringified TypeOrm where query |
| select | object | no | Stringified TypeOrm select query |

### POST /api/v2/user/audits
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/audit-controller-create-user-audits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /api/v2/user/oauth/authorize
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/authentications-authorize-oauth-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| response_type | string | yes |  |
| client_id | string | yes |  |
| redirect_uri | string | no |  |
| scope | string | no |  |
| state | string | no |  |
| code_challenge | string | no |  |
| code_challenge_method | string | no |  |
| error_code | string | no |  |

### GET /api/v2/user/oauth/forgotten
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/authentications-get-forgotten-oauth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | no |  |

### POST /api/v2/user/oauth/auth/login
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/authentications-post-oauth-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /api/v2/user/oauth/auth/reset
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/authentications-reset-oauth-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /api/v2/user/oauth/token
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/authentications-create-user-oauth-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /api/v2/user/oauth/exchange
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/authentications-exchange-oauth-token` (byok)

### POST /api/v2/user/oauth/logout
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/authentications-perform-logout` (byok)

### GET /api/v2/user/oauth/mfa
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/authentications-get-mfa-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | no |  |
| csrf_token | string | no |  |
| state | string | no |  |
| error | string | no |  |

### POST /api/v2/user/oauth/check-mfa-code
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/authentications-check-mfa-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Fetches organizations in batches set by perPage (default 20). Should be used mainly from UI.
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-organizations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | Index of page |
| perPage | number | no | Page size |
| globalFilter | string | no | Global filter of filterable fields |
| order | object | no | Stringified TypeOrm order |
| where | array | no | Stringified TypeOrm where query |
| select | object | no | Stringified TypeOrm select query |

### POST /api/v2/user/organizations
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-create-user-organization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Fetches organization hierarchy chart
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-organization-chart` (byok)

### GET /api/v2/user/organizations/find
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-find-user-organizations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skip | number | no |  |
| take | number | no |  |
| relations | array | no |  |
| order | object | no |  |
| where | array | no |  |
| select | object | no |  |

### GET /api/v2/user/organizations/find/ids
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-find-user-organization-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ids | array | no |  |
| select | object | no |  |

### GET /api/v2/user/organizations/list
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-list-user-organizations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skip | number | no |  |
| take | number | no |  |
| relations | array | no |  |
| order | object | no |  |
| where | array | no |  |
| select | object | no |  |

### GET /api/v2/user/organizations/{id}/endorsements
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-user-endorsements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| page | number | no | Index of page |
| perPage | number | no | Page size |
| globalFilter | string | no | Global filter of filterable fields |
| order | object | no | Stringified TypeOrm order |
| where | array | no | Stringified TypeOrm where query |
| select | object | no | Stringified TypeOrm select query |

### GET /api/v2/user/organizations/{id}
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### PATCH /api/v2/user/organizations/{id}
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-update-organization-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | no | JSON request body |

### DELETE /api/v2/user/organizations/{id}
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-delete-organization-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### GET /api/v2/user/organizations/{id}/stripe-account
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-stripe-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### GET /api/v2/user/organizations/{id}/closure-values
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-closure-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Returns the assigned policies of a requested organization
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Returns detailed information for an organization
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-organization-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### GET /api/v2/user/organizations/{id}/api-tokens
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-user-api-tokens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| page | number | no | Index of page |
| perPage | number | no | Page size |
| globalFilter | string | no | Global filter of filterable fields |
| order | object | no | Stringified TypeOrm order |
| where | array | no | Stringified TypeOrm where query |
| select | object | no | Stringified TypeOrm select query |

### GET /api/v2/user/organizations/{id}/setup
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-user-organization-setup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### GET /api/v2/user/organizations/{id}/descendantIds
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-descendant-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### GET /api/v2/user/organizations/{id}/name
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-organization-name-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### GET /api/v2/user/organizations/{id}/insured-ids
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-insured-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Returns list of insurers assigned for requested organization
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-list-insurer-assigned-for-organizati` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Update list of insurers assigned for organization
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-update-insurers-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | yes | JSON request body |

### Returns the assigned policies of a requested organization
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-get-assigned-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Assign policies for requested organization
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/organization-controller-assign-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | yes | JSON request body |

### GET /api/v2/user/organizations/organization-policies/{id}
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/organization-policy-controller-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### DELETE /api/v2/user/organizations/organization-policies/{policyId}
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/organization-policy-controller-delete-policy-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| policyId | string | yes |  |

### Fetches roles in batches set by perPage (default 20). Should be used mainly from UI.
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/role-controller-get-user-roles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | Index of page |
| perPage | number | no | Page size |
| globalFilter | string | no | Global filter of filterable fields |
| order | object | no | Stringified TypeOrm order |
| where | array | no | Stringified TypeOrm where query |
| select | object | no | Stringified TypeOrm select query |

### POST /api/v2/user/roles
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/role-controller-create-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /api/v2/user/roles/{id}
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/role-controller-get-user-roles-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### PATCH /api/v2/user/roles/{id}
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/role-controller-update-user-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | no | JSON request body |

### DELETE /api/v2/user/roles/{id}
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/role-controller-delete-user-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### GET /api/v2/user/status
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/status-controller-get-user-status` (byok)

### Fetches users in batches set by perPage (default 20). Should be used mainly from UI.
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-get-users-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | number | no | Index of page |
| perPage | number | no | Page size |
| globalFilter | string | no | Global filter of filterable fields |
| order | object | no | Stringified TypeOrm order |
| where | array | no | Stringified TypeOrm where query |
| select | object | no | Stringified TypeOrm select query |

### POST /api/v2/user/users
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /api/v2/user/users/find
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-find-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| skip | number | no |  |
| take | number | no |  |
| relations | array | no |  |
| order | object | no |  |
| where | array | no |  |
| select | object | no |  |

### GET /api/v2/user/users/generate-otp-secret
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-generate-otp-secret` (byok)

### GET /api/v2/user/users/{id}
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### PATCH /api/v2/user/users/{id}
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-update-user-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | no | JSON request body |

### DELETE /api/v2/user/users/{id}
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-delete-user-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### GET /api/v2/user/users/{id}/profile
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-get-user-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### PATCH /api/v2/user/users/{id}/profile
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-update-user-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| body | object | no | JSON request body |

### POST /api/v2/user/users/setup-otp
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-setup-otp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### GET /api/v2/user/users/{id}/roles
`GET https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-get-user-roles-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### POST /api/v2/user/users/password
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-reset-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /api/v2/user/users/reset-password
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-reset-password-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /api/v2/user/users/{id}/reset-password
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-reset-user-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### POST /api/v2/user/users/generate-mfa-code
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-generate-mfa-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### POST /api/v2/user/users/reset-mfa-type
`POST https://zieapi.vercel.app/v1/ecommerce:redkik/user-controller-reset-mfa-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/ecommerce:redkik/api-token-controller-create-user-api-token" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Redkik userservice API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/ecommerce:redkik/api-token-controller-create-user-api-token with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Redkik userservice API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Redkik userservice itself also needs your own key from sales.app.redkik.com.

### Can AI agents use the Redkik userservice API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:redkik.

### What is the status of the Redkik userservice API?
Needs your own provider key (bring your own key)