Skip to main content
POST
Criar solicitação de consentimento ativo

Headers

Api-Key
string
required

Body

casoDeUsoIdTemplate
string | null
required

Identificador do template do caso de uso.

cpfTitular
string | null
required

CPF do titular do consentimento.

callbackUrl
string | null
required

URL responsável por receber o webhook com a hash de consulta assinada, após processamento da PGCC e Autorize.

modalidadeAcesso
enum<string>
required
Available options:
Direto,
Indireto
tipoTitular
enum<string>
required
Available options:
PessoaFisica
dataExpiracaoConsentimento
string<date-time>
required

Data de expiração do consentimento.

dataTitularRespondeuConsentimento
string<date-time>
required

Data em que o titular respondeu ao consentimento.

provaColeta
string | null
required

Prova de coleta do consentimento.

cnpjAnuente
string | null

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

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