---
title: "Who am I: the actor, the organization, the environment, the permissions and the provider"
description: "Answers for any valid credential. With a person's access token and no X-Organization header it describes the person only; with the header, or with a service-account key, it also describes the organization this credential acts on."
---

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

Path: Invox API › Identity

`GET /v1/me`

Answers for any valid credential. With a person's access token and no X-Organization header it describes the person only; with the header, or with a service-account key, it also describes the organization this credential acts on.

## Authentication

- `bearer`, http, header `Authorization`

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.invox.page/v1/me \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.invox.page/v1/me';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.invox.page/v1/me"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

The credential, described.

#### Example

```json
{
  "actor": {
    "id": "string",
    "type": "user"
  },
  "credential": {
    "type": "access_token",
    "id": "string"
  },
  "organization": null,
  "scopes": [],
  "next_steps": [
    "string"
  ]
}
```

Any of:

- `object`
  - `actor` (`get-me.response.200.1.actor`; object, required)
    - `id` (`get-me.response.200.1.actor.id`; string, required)
    - `type` (`get-me.response.200.1.actor.type`; string, required)
      - one of `"user"`, `"service_account"`, `"service"`
  - `credential` (`get-me.response.200.1.credential`; object, required)
    - `type` (`get-me.response.200.1.credential.type`; string, required)
      - one of `"access_token"`, `"api_key"`, `"preview_link"`, `"none"`
    - `id` (`get-me.response.200.1.credential.id`; string | null, required)
  - `organization` (`get-me.response.200.1.organization`; null, required)
  - `scopes` (`get-me.response.200.1.scopes`; array<string>, required)
  - `next_steps` (`get-me.response.200.1.next_steps`; array<string>, required)
- `object`
  - `actor` (`get-me.response.200.2.actor`; object, required)
    - `id` (`get-me.response.200.2.actor.id`; string, required)
    - `type` (`get-me.response.200.2.actor.type`; string, required)
      - one of `"user"`, `"service_account"`, `"service"`
  - `credential` (`get-me.response.200.2.credential`; object, required)
    - `type` (`get-me.response.200.2.credential.type`; string, required)
      - one of `"access_token"`, `"api_key"`, `"preview_link"`, `"none"`
    - `id` (`get-me.response.200.2.credential.id`; string | null, required)
  - `organization` (`get-me.response.200.2.organization`; object, required)
    - `id` (`get-me.response.200.2.organization.id`; string, required)
    - `name` (`get-me.response.200.2.organization.name`; string | null, required)
    - `environment` (`get-me.response.200.2.organization.environment`; string, required)
      - one of `"live"`, `"test"`
    - `status` (`get-me.response.200.2.organization.status`; string, required)
      - one of `"active"`, `"suspended"`, `"archived"`
    - `paired_organization_id` (`get-me.response.200.2.organization.paired_organization_id`; string | null, required)
  - `scopes` (`get-me.response.200.2.scopes`; array<string>, required)
  - `providers` (`get-me.response.200.2.providers`; array<object>, required) — Who answers when this credential issues, by the series of the invoice: the simulator never reaches SUNAT. GET /v1/provider adds the state of each provider account.
    - `code` (`get-me.response.200.2.providers.code`; string, required)
      - one of `"simulator"`, `"bizlinks"`
    - `mode` (`get-me.response.200.2.providers.mode`; string, required)
      - one of `"simulator"`, `"sandbox"`, `"production"`
    - `series` (`get-me.response.200.2.providers.series`; array<string>, required)
  - `provider` (`get-me.response.200.2.provider`; any of, required) — The first connection of the organization: who answers for its first series. `providers` has them all.
    - any of:
      - `object`
        - `code` (`get-me.response.200.2.provider.1.code`; string, required)
          - one of `"simulator"`, `"bizlinks"`
        - `mode` (`get-me.response.200.2.provider.1.mode`; string, required)
          - one of `"simulator"`, `"sandbox"`, `"production"`
      - `null`
  - `issuer_configured` (`get-me.response.200.2.issuer_configured`; boolean, required)
  - `test_scenarios_allowed` (`get-me.response.200.2.test_scenarios_allowed`; boolean, required) — The `Test-Scenario` header applies to the series the simulator serves.

### 401

`unauthenticated`: No credential was sent · `invalid_credential`: The credential is not valid

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-me.response.401.type`; string, required)
  - format `uri`
- `title` (`get-me.response.401.title`; string, required)
- `status` (`get-me.response.401.status`; integer, required)
- `code` (`get-me.response.401.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"unauthenticated"`, `"invalid_credential"`
- `retryable` (`get-me.response.401.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-me.response.401.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-me.response.401.next_steps`; array<string>, required)
- `request_id` (`get-me.response.401.request_id`; string, required)
- `detail` (`get-me.response.401.detail`; string, optional)
- `errors` (`get-me.response.401.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-me.response.401.errors.path`; string, required)
  - `code` (`get-me.response.401.errors.code`; string, required)
  - `message` (`get-me.response.401.errors.message`; string, required)
  - `context` (`get-me.response.401.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-me.response.401.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-me.response.401.third_party.source`; string, required)
  - `message` (`get-me.response.401.third_party.message`; string, required)
  - `code` (`get-me.response.401.third_party.code`; string, optional)

### 429

`rate_limited`: Too many requests

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-me.response.429.type`; string, required)
  - format `uri`
- `title` (`get-me.response.429.title`; string, required)
- `status` (`get-me.response.429.status`; integer, required)
- `code` (`get-me.response.429.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"rate_limited"`
- `retryable` (`get-me.response.429.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-me.response.429.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-me.response.429.next_steps`; array<string>, required)
- `request_id` (`get-me.response.429.request_id`; string, required)
- `detail` (`get-me.response.429.detail`; string, optional)
- `errors` (`get-me.response.429.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-me.response.429.errors.path`; string, required)
  - `code` (`get-me.response.429.errors.code`; string, required)
  - `message` (`get-me.response.429.errors.message`; string, required)
  - `context` (`get-me.response.429.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-me.response.429.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-me.response.429.third_party.source`; string, required)
  - `message` (`get-me.response.429.third_party.message`; string, required)
  - `code` (`get-me.response.429.third_party.code`; string, optional)

### 500

`internal_error`: The service failed

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-me.response.500.type`; string, required)
  - format `uri`
- `title` (`get-me.response.500.title`; string, required)
- `status` (`get-me.response.500.status`; integer, required)
- `code` (`get-me.response.500.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"internal_error"`
- `retryable` (`get-me.response.500.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-me.response.500.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-me.response.500.next_steps`; array<string>, required)
- `request_id` (`get-me.response.500.request_id`; string, required)
- `detail` (`get-me.response.500.detail`; string, optional)
- `errors` (`get-me.response.500.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-me.response.500.errors.path`; string, required)
  - `code` (`get-me.response.500.errors.code`; string, required)
  - `message` (`get-me.response.500.errors.message`; string, required)
  - `context` (`get-me.response.500.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-me.response.500.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-me.response.500.third_party.source`; string, required)
  - `message` (`get-me.response.500.third_party.message`; string, required)
  - `code` (`get-me.response.500.third_party.code`; string, optional)

### 503

`service_unavailable`: The service cannot answer right now

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-me.response.503.type`; string, required)
  - format `uri`
- `title` (`get-me.response.503.title`; string, required)
- `status` (`get-me.response.503.status`; integer, required)
- `code` (`get-me.response.503.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"service_unavailable"`
- `retryable` (`get-me.response.503.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-me.response.503.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-me.response.503.next_steps`; array<string>, required)
- `request_id` (`get-me.response.503.request_id`; string, required)
- `detail` (`get-me.response.503.detail`; string, optional)
- `errors` (`get-me.response.503.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-me.response.503.errors.path`; string, required)
  - `code` (`get-me.response.503.errors.code`; string, required)
  - `message` (`get-me.response.503.errors.message`; string, required)
  - `context` (`get-me.response.503.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-me.response.503.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-me.response.503.third_party.source`; string, required)
  - `message` (`get-me.response.503.third_party.message`; string, required)
  - `code` (`get-me.response.503.third_party.code`; string, optional)


Source: https://docs.invox.page/api/get-me/index.md
