Ir al contenido

Consultar la cuenta y los permisos de la llave

GET
/me
FACTUCAT_API_URL="${FACTUCAT_API_URL:-https://sandbox.factucat.com/api/v1}"
curl --fail-with-body --request GET \
--url "$FACTUCAT_API_URL/me" \
--header "X-API-Key: $FACTUCAT_API_KEY"

Operación exitosa

Media typeapplication/json
object
data
required
object
actorType
required
string
>= 1 characters
actorId
required
string
>= 1 characters
ownerUserId
required
string
>= 1 characters
ownerUserName
string
>= 1 characters
ownerUserEmail
string format: email
/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
scopes
required
Array<string>
meta
required
object
requestId
required
string
>= 1 characters
idempotencyKey
string
>= 1 characters
pagination
object
limit
required
integer
> 0 <= 9007199254740991
offset
required
integer
<= 9007199254740991
hasMore
required
boolean
nextCursor
string | null

Datos inválidos

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

API key ausente, inválida o de otro ambiente

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

Plan inactivo o permisos insuficientes

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

Recurso no encontrado

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

Método no permitido

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

Conflicto o solicitud en curso. error.reason es opcional; duplicate_rfc indica que ya existe un cliente con ese RFC en la cuenta; stamp_in_progress indica que el documento se está timbrando: consúltalo antes de reintentar.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

Límite de solicitudes alcanzado

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string
Retry-After
integer

Segundos antes de reintentar.

Error interno

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string

PAC temporalmente no disponible

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: bad_request conflict csd_required forbidden internal_error pac_unavailable invalid_api_key invalid_json method_not_allowed missing_api_key missing_idempotency_key missing_scope not_found plan_required rate_limit_exceeded validation_error invalid_input INVALID_ISSUE_DATE idempotency_conflict idempotency_in_progress
message
required
string
>= 1 characters
requestId
required
string
>= 1 characters
retryable
required
boolean
reason
string