Skip to main content
POST
Add an entity identifier

Authorizations

X-API-Key
string
header
required

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

Path Parameters

entityId
string<uuid>
required

Body

application/json
country
enum<string>
required
write-only

Country that issued the identifier

Available options:
mx
Example:

"mx"

identifier
enum<string>
required
write-only

Kind of identifier to add to the entity

Available options:
curp,
rfc
Example:

"rfc"

value
string
required
write-only

Identifier value

Example:

"XAXX010101000"

Response

Entity identifier resource response

@id
string<iri-reference>

Entity identifier IRI reference

Example:

"/.well-known/genid/78c595ac88fa9659fa80"

@type
string
default:EntityIdentifier

JSON-LD resource type

id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

Entity IRI reference

Example:

"/entities/91106968-1abd-4d64-85c1-4e73d96fb997"

country
enum<string>

Country that issued the identifier

Available options:
mx
Example:

"mx"

identifier
enum<string>

Kind of identifier for the entity

Available options:
curp,
rfc
Example:

"rfc"

value
string

Identifier value

Example:

"XAXX010101000"

createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"