Skip to main content
POST
/
api
/
solicitacao-consentimento
/
criar
/
ativo
Criar solicitação de consentimento ativo
curl --request POST \
  --url https://usuario-api.autorize.com.br/api/solicitacao-consentimento/criar/ativo \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "casoDeUsoIdTemplate": "<string>",
  "cpfTitular": "<string>",
  "callbackUrl": "<string>",
  "dataExpiracaoConsentimento": "2023-11-07T05:31:56Z",
  "dataTitularRespondeuConsentimento": "2023-11-07T05:31:56Z",
  "provaColeta": "<string>",
  "cnpjAnuente": "<string>"
}
'
{
  "sucesso": true,
  "isPgccErro": true,
  "mensagem": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pgccId": "<string>"
  }
}

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