Persona autenticada

GET /api/v4/me devuelve la persona a la que pertenece la API key con la que haces la petición: su tenant, el ambiente que responde, si es el owner, lo que puede hacer y sus saldos. Úsalo para validar una credencial antes de operar.

Modelo persona autenticada

El modelo persona autenticada describe la persona de la API key, con sus permisos y saldos. Obtener persona autenticada lo devuelve.

Properties

Name
id
Type
string?
Description
Identificador único de la persona.
Name
legalName
Type
string?
Description
Razón social o nombre de la persona.
Name
tin
Type
string?
Description
RFC de la persona.
Name
email
Type
string?
Description
Correo electrónico de la persona.
Name
tenantId
Type
string?
Description
Identificador del tenant al que pertenece la API key. Es el tenant de X-TENANT-KEY.
Name
environment
Type
string?
Description
Ambiente que responde la petición: Test o Production.
Name
isOwner
Type
boolean?
Description
true si la persona es el owner del tenant, es decir, la persona que lo creó.
Name
features
Type
object?
Description
Roles, permisos concedidos y negados, features del tenant, suscripción y asientos (seatAssignments) de la persona.
Name
balances
Type
array of objects?
Saldo por tipo de crédito. Un tipo que no aparece en la lista tiene saldo 0.
Name
creditType
Type
integer | number?
expandible
Description
Tipo de crédito.
Type
enum:
Values
123
Name
available
Type
integer | number?
Description
Saldo disponible de ese tipo de crédito.

GET/api/v4/me

Obtener persona autenticada

Este endpoint no recibe parámetros. Siempre responde la persona de la API key que envías. No devuelve secretos ni datos de otras personas.

Errores

El endpoint responde el estado de la tabla con el mensaje en details del modelo de respuesta.

Estado	Cuándo ocurre	Mensaje
401	No llega el header X-TENANT-KEY.	Missing required http X-TENANT-KEY.
401	No llega el header X-API-KEY.	Missing required http X-API-KEY.
401	El tenant no existe.	Invalid tenant key
401	La API key no es válida o es de otro tenant.	Invalid API KEY
401	La persona de la API key está desactivada.	Tu cuenta está desactivada. Escríbenos a soporte@fiscalapi.com.
403	El tenant está desactivado.	El tenant está desactivado. Escríbenos a soporte@fiscalapi.com.

Request

GET

/api/v4/me

curl --location 'https://test.fiscalapi.com/api/v4/me' \
--header 'X-TENANT-KEY: <tenant-key>' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: <api-key>'

Response

{
  "data": {
    "id": "78d380fd-1b69-4e3c-8bc0-4f57737f7d5f",
    "legalName": "KARLA FUENTE NOLASCO",
    "tin": "FUNK671228PH6",
    "email": "persona@example.com",
    "tenantId": "102e5f13-e114-41dd-bea7-507fce177281",
    "environment": "Test",
    "isOwner": true,
    "features": {
      "isOwner": true,
      "roles": [
        "Owner"
      ],
      "permissions": [
        "SatValidations.Read",
        "SatValidations.Run",
        "Invoices.Read",
        "Invoices.Issue",
        "Invoices.Cancel",
        "Invoices.Send",
        "Invoices.CheckStatus",
        "Invoices.Calculate",
        "Tickets.Read",
        "AutoInvoice.Read",
        "StripeApp.Read",
        "StripeApp.Manage",
        "Webhooks.Manage",
        "XmlDownloader.Read",
        "Billing.Read",
        "Billing.Purchase",
        "ApiKeys.Manage",
        "Reports.Manage",
        "Catalogs.Read",
        "Products.Manage",
        "TaxFiles.Manage",
        "People.Manage",
        "Kpis.Read",
        "Manifests.Manage",
        "TestAccounts.Reactivate",
        "Credits.Read",
        "Credits.Transfer",
        "Credits.TransferOnBehalf"
      ],
      "denied": {
        "Tickets.Create": {
          "missingFeatures": [
            "auto_cfdi"
          ]
        },
        "Tickets.Cancel": {
          "missingFeatures": [
            "auto_cfdi"
          ]
        },
        "AutoInvoice.Manage": {
          "missingFeatures": [
            "auto_cfdi"
          ]
        },
        "DownloadRules.Create": {
          "missingFeatures": [
            "descarga_cfdi"
          ]
        }
      },
      "features": {
        "emision_cfdi": {
          "values": {}
        }
      },
      "subscription": {
        "status": "active",
        "isAvailable": true
      },
      "seatAssignments": []
    },
    "balances": [
      {
        "creditType": 1,
        "available": 7
      },
      {
        "creditType": 2,
        "available": 3
      }
    ]
  },
  "succeeded": true,
  "message": "",
  "details": "",
  "httpStatusCode": 200
}