Skip to main content
POST
/
credentials
Create a credential
curl --request POST \
  --url https://api.syntage.com/credentials \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "type": "<string>",
  "rfc": "PEIC211118IS0",
  "password": "secret123"
}
'
{
  "@context": "/contexts/Credential",
  "@id": "/credentials/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "Credential",
  "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
  "type": "ciec",
  "rfc": "PEIC211118IS0",
  "status": "pending",
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json

CIEC

​
type
string
required

Credential type

​
rfc
string
required

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13
Example:

"PEIC211118IS0"

​
password
string
required
write-only

CIEC's password

Minimum string length: 8
Example:

"secret123"

Response

Credential resource response

​
@context
string
default:/contexts/Credential
​
@id
string<iri-reference>

SAT Credential IRI reference

Example:

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

​
@type
string
default:Credential
​
id
string<uuid>

Credential ID

Example:

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

​
type
enum<string>
Available options:
ciec,
efirma
Example:

"ciec"

​
rfc
string

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13
Example:

"PEIC211118IS0"

​
status
enum<string>

Credential validation status:

ValueDescription
waitingCredential validation is temporarily disabled, usually because of an ongoing incident. The credential will be validated later.
pendingCredential validation has been requested and is waiting to be processed.
validThe credential was accepted by SAT and can be used for extractions.
invalidSAT rejected the credential during validation.
disabledSAT reported the credential as disabled or otherwise unrecoverable during validation.
deactivatedDeprecated. Legacy status retained for existing records. The disabled status is used for credentials that can no longer be used.
errorCredential validation failed because of an unexpected error.
Available options:
waiting,
pending,
valid,
invalid,
disabled,
deactivated,
error
Example:

"pending"

​
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"