Fluxo de renovação do consentimento

patch https://api-openfinance.opb.bricks.demo.fsapps.io/api/admin/data-reception/v1/consents/{consentId}

Responses

Response body

object

consent

object

permissions

array of strings

required

length between 1 and 99

permissions*

expirationDateTime

date-time

required

length ≤ 20

Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).

loggedUser

object

required

Usuário (pessoa natural) que encontra-se logado na instituição receptora e que iniciará o processo de consentimento para compartilhamento de dados.

kind

string

required

Tipo do fluxo de consentimento. Para o Banking temos somente a possibilidade de compartilhamento de dados (DATA). Caso haja um novo fluxo (fazendo um de para com openbanking, também temos a possibilidade do consentimento de pagamento).

applicantId

string

required

ID da organização

applicantSoftwareId

string

required

Id do software statement

creationDateTime

date-time

required

length ≤ 21

Data e hora de criação do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).

statusUpdateDateTime

date-time

required

length ≤ 21

Data e hora de alteração do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).

status

string

required

Status do consentimento

consentId

string

required

length ≤ 256

ID único do consentimento

consentTerm

integer

required

(*Confirmar)

consentTermUnit

string

required

Termo do consentimento

organizationName

string

required

Nome da organização

organizationLogo

uri

required

Logo da organização

Headers

object

Content-Type

string

length between 1 and 100

Content-Length

integer

Connection

string

length between 1 and 100

X-Powered-By

string

length between 1 and 100

x-correlation-id

string

length between 1 and 100

ETag

string

length between 1 and 100

Date

string

length between 1 and 100

X-Kong-Upstream-Latency

integer

X-Kong-Proxy-Latency

integer

Via

string

length between 1 and 100

Language


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api-openfinance.opb.bricks.demo.fsapps.io/api/admin/data-reception/v1/consents/consentId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/json; charset=utf-8

201Consentimento criado com sucesso.

401Cabeçalho de autenticação ausente/inválido ou token inválido

404O recurso solicitado não existe ou não foi implementado

500Ocorreu um erro no gateway da API ou no microsserviço