Skip to main content
POST
/
api
/
hash-consulta
Criar hash de consulta
curl --request POST \
  --url https://usuario-api.autorize.com.br/api/hash-consulta \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateId": "<string>",
  "isConsentimento": true,
  "idPgccConsentimento": "<string>",
  "cnpjAnuente": "<string>",
  "dataExpiracao": "2023-11-07T05:31:56Z",
  "cpfOperador": "<string>"
}
'
{
  "sucesso": true,
  "isPgccErro": true,
  "mensagem": "<string>",
  "data": {
    "hash": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Headers

​
Api-Key
string
required

Body

​
templateId
string | null

Identificador do template do caso de uso.

​
isConsentimento
boolean | null

Indica se a hash está associada a um consentimento.

​
idPgccConsentimento
string | null

Identificador do consentimento na PGCC. Obrigatório quando IsConsentimento for verdadeiro.

​
cnpjAnuente
string | null

CNPJ do anuente. Obrigatório somente em modalidade de acesso "Indireto".

​
dataExpiracao
string<date-time> | null

Data de expiração da hash de consulta.

​
cpfOperador
string | null

CPF do operador responsável pela criação da hash.

Response

OK

​
sucesso
boolean
​
isPgccErro
boolean
​
pgccCodigoErro
enum<string>
Available options:
Continue,
SwitchingProtocols,
Processing,
EarlyHints,
OK,
Created,
Accepted,
NonAuthoritativeInformation,
NoContent,
ResetContent,
PartialContent,
MultiStatus,
AlreadyReported,
IMUsed,
MultipleChoices,
MovedPermanently,
Found,
SeeOther,
NotModified,
UseProxy,
Unused,
TemporaryRedirect,
PermanentRedirect,
BadRequest,
Unauthorized,
PaymentRequired,
Forbidden,
NotFound,
MethodNotAllowed,
NotAcceptable,
ProxyAuthenticationRequired,
RequestTimeout,
Conflict,
Gone,
LengthRequired,
PreconditionFailed,
RequestEntityTooLarge,
RequestUriTooLong,
UnsupportedMediaType,
RequestedRangeNotSatisfiable,
ExpectationFailed,
MisdirectedRequest,
UnprocessableEntity,
Locked,
FailedDependency,
UpgradeRequired,
PreconditionRequired,
TooManyRequests,
RequestHeaderFieldsTooLarge,
UnavailableForLegalReasons,
InternalServerError,
NotImplemented,
BadGateway,
ServiceUnavailable,
GatewayTimeout,
HttpVersionNotSupported,
VariantAlsoNegotiates,
InsufficientStorage,
LoopDetected,
NotExtended,
NetworkAuthenticationRequired
​
mensagem
string | null
​
data
object