Skip to main content
POST
Criar hash de consulta

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