Skip to main content
GET
List all credentials

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Query Parameters

type
enum<string>

Filter by type (exact match)

Available options:
ciec,
efirma
Example:

"ciec"

rfc
string

Filter by RFC (Registro Federal de Contribuyentes, partial match)

Required string length: 12 - 13
Example:

"PEIC211118IS0"

status
enum<string>

Filter by status (exact match) Credential validation status:

Available options:
waiting,
pending,
valid,
invalid,
disabled,
deactivated,
error
Example:

"pending"

deactivatedAt[before]
string<date-time>

Filter by deactivation date (less than or equal <=)

deactivatedAt[strictly_before]
string<date-time>

Filter by deactivation date (less than <)

deactivatedAt[after]
string<date-time>

Filter by deactivation date (greater than or equal >=)

deactivatedAt[strictly_after]
string<date-time>

Filter by deactivation date (greater than >)

createdAt[before]
string<date-time>

Filter by resource creation date (less than or equal <=)

createdAt[strictly_before]
string<date-time>

Filter by resource creation date (less than <)

createdAt[after]
string<date-time>

Filter by resource creation date (greater than or equal >=)

createdAt[strictly_after]
string<date-time>

Filter by resource creation date (greater than >)

order[createdAt]
enum<string>

Order by resource creation date

Available options:
asc,
desc
Example:

"asc"

page
integer
default:1

Collection page number

itemsPerPage
integer
default:20

Number of items per page

Required range: 1 <= x <= 1000

Response

Credential collection response

@context
string
default:/contexts/Credential
@id
string
default:/credentials
@type
string
default:hydra:Collection
hydra:member
object[]
hydra:view
object

Pagination information