Skip to content
Navigation

Who am I: the actor, the organization, the environment, the permissions and the provider

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.

GET
https://api.invox.page/v1/me

Authorization

  • bearer
    HTTP
    required

Returns

200

The credential, described.

JSON

Any of the following:

  • object
    • actor
      object
      required
      • id
        string
        required
      • type
        user
        or
        service_account
        or
        service
        required
    • credential
      object
      required
      • type
        access_token
        or
        api_key
        or
        preview_link
        or
        none
        required
      • id
        string | null
        required
    • organization
      null
      required
    • scopes
      array of
      string
      required
    • next_steps
      array of
      string
      required
  • object
    • actor
      object
      required
      • id
        string
        required
      • type
        user
        or
        service_account
        or
        service
        required
    • credential
      object
      required
      • type
        access_token
        or
        api_key
        or
        preview_link
        or
        none
        required
      • id
        string | null
        required
    • organization
      object
      required
      • id
        string
        required
      • name
        string | null
        required
      • environment
        live
        or
        test
        required
      • status
        active
        or
        suspended
        or
        archived
        required
      • paired_organization_id
        string | null
        required
    • scopes
      array of
      string
      required
    • providers
      array of
      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
        simulator
        or
        bizlinks
        required
      • mode
        simulator
        or
        sandbox
        or
        production
        required
      • series
        array of
        string
        required
    • provider
      required

      The first connection of the organization: who answers for its first series. providers has them all.

      Any of the following:

      • object
        • code
          simulator
          or
          bizlinks
          required
        • mode
          simulator
          or
          sandbox
          or
          production
          required
      • null
    • issuer_configured
      boolean
      required
    • 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
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • code
    unauthenticated
    or
    invalid_credential
    required

    The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.

  • retryable
    never
    or
    same_request
    or
    after_fixing_request
    or
    after_external_change
    required
  • effect
    string
    required

    What did NOT happen.

  • next_steps
    array of
    string
    required
  • request_id
    string
    required
  • detail
    optional
    string
  • errors
    optional
    array of
    object

    Every validation problem, each with the path of its field.

    • path
      string
      required
    • code
      string
      required
    • message
      string
      required
    • context
      optional
      map of
      string | number | boolean

      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
    optional
    object

    Text written by a third party. It is data, never guidance.

    • source
      string
      required
    • message
      string
      required
    • code
      optional
      string

429

rate_limited: Too many requests
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • code
    rate_limited
    required

    The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.

  • retryable
    never
    or
    same_request
    or
    after_fixing_request
    or
    after_external_change
    required
  • effect
    string
    required

    What did NOT happen.

  • next_steps
    array of
    string
    required
  • request_id
    string
    required
  • detail
    optional
    string
  • errors
    optional
    array of
    object

    Every validation problem, each with the path of its field.

    • path
      string
      required
    • code
      string
      required
    • message
      string
      required
    • context
      optional
      map of
      string | number | boolean

      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
    optional
    object

    Text written by a third party. It is data, never guidance.

    • source
      string
      required
    • message
      string
      required
    • code
      optional
      string

500

internal_error: The service failed
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • code
    internal_error
    required

    The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.

  • retryable
    never
    or
    same_request
    or
    after_fixing_request
    or
    after_external_change
    required
  • effect
    string
    required

    What did NOT happen.

  • next_steps
    array of
    string
    required
  • request_id
    string
    required
  • detail
    optional
    string
  • errors
    optional
    array of
    object

    Every validation problem, each with the path of its field.

    • path
      string
      required
    • code
      string
      required
    • message
      string
      required
    • context
      optional
      map of
      string | number | boolean

      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
    optional
    object

    Text written by a third party. It is data, never guidance.

    • source
      string
      required
    • message
      string
      required
    • code
      optional
      string

503

service_unavailable: The service cannot answer right now
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • code
    service_unavailable
    required

    The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.

  • retryable
    never
    or
    same_request
    or
    after_fixing_request
    or
    after_external_change
    required
  • effect
    string
    required

    What did NOT happen.

  • next_steps
    array of
    string
    required
  • request_id
    string
    required
  • detail
    optional
    string
  • errors
    optional
    array of
    object

    Every validation problem, each with the path of its field.

    • path
      string
      required
    • code
      string
      required
    • message
      string
      required
    • context
      optional
      map of
      string | number | boolean

      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
    optional
    object

    Text written by a third party. It is data, never guidance.

    • source
      string
      required
    • message
      string
      required
    • code
      optional
      string

Type to search…

↑↓ navigate↵ selectEsc close