Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Tip

Collection Open Keys - Compartilhamento de Dados

...

View file
nameSmart-Key Dados Celcoin Homolog - Yampa.postman_collection.json

 

POST Token

Info

Para iniciar uma jornada é necessário gerar um token no qual devem ser indicados To start a journey, it is necessary to generate a token in which client_ide and client_secret, conforme modelo abaixo.

...

must be indicated , according to the model below.

 

Token generation URL

Panel
bgColor#F4F5F7

https://onboard.smartkeys.engdev.fsapps.io/api/portal/onboard/v1/token

 

cURL para geração do for Token generation

Code Block
curl --location 'https://onboard.smartkeys.engdev.fsapps.io/api/portal/onboard/v1/token' \
--header 'Content-Type: application/json' \
--data '{   
    "client_id":"e1987ec5-2567-4048e****ec5-2**7-4**8-ace9-6e6d7b9f77fc6e****9f77fc",
    "client_secret": "bb4c8136bb4****6-874a-42ce-bbdc-ac422f5f5b71***e-b**c-ac42*****71"
}'

 

Response:

Code Block
{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OEhCYTFqdlZPMGVVcDl6aW5ldmJVaG9uSlI2cEJsOHBoQnVsSXAwIn0eyJ********NiIsInR5cC*******iw****IiA6I*YTFqdlZPMG*****VVcDl6aW5ldmJVaG9uSlI2cEJsOHBoQnVsSXAwIn0.eyJleHAiOjE2ODA2MjE3OTIsImlhdCI6MTY4MDYxODE5MiwianRpIjoiNmMyMjAyMjUtOTJlZS00YTFkLWE3MGUtMWFjZGZmNDE3OGI4IiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5mdWxsLWRldi5maW5hbnN5c3RlY2guY29tLmJyL2F1dGgvcmVhbG1zL3NtYXJ0LWtleXMiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiOTEzYTBmZjYtNjE4Yy00NDM3LWE0ZWUtMmU0ZmQyYzVmMDU4IiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiZTE5ODdlYzUtMjU2Ny00MDQ4LWFjZTktNmU2ZDdiOWY3N2ZjIiwiYWNyIjoiMSIsInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsImRlZmF1bHQtcm9sZXMtc21hcnQta2V5cyIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiZTE5ODdlYzUtMjU2Ny00MDQ4LWFjZTktNmU2ZDdiOWY3N2ZjIjp7InJvbGVzIjpbInVtYV9wcm90ZWN0aW9uIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6ImVtYWlsIHByb2ZpbGUiLCJjbGllbnRJZCI6ImUxOTg3ZWM1LTI1NjctNDA0OC1hY2U5LTZlNmQ3YjlmNzdmYyIsImNsaWVudEhvc3QiOiIxMC4yNDAuMC4xMCIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic2VydmljZS1hY2NvdW50LWUxOTg3ZWM1LTI1NjctNDA0OC1hY2U5LTZlNmQ3YjlmNzdmYyIsImNsaWVudEFkZHJlc3MiOiIxMC4yNDAuMC4xMCJ9.fRaM_i2uIohrN8WcOmlD4M3bJf4lu8zEtKKNv3dW9xiP2QmvDTCX3LIgcwakMFTahjZdIJFK95ioaEPvQpLK38QXAKJPMfzEjar39ruUNth4pqiE8iPBGTV4lNSIMArMI-pgBOpJCr2lLDfKnjvrkIqf1rrnCGdZc8UhpxkJtbtFBVDlvQBnFp-N_KiKyYIIvUvEqzHxetag9W715b9DqoDynHp_Pf7kkk1g5P4U7cQjKlKAYNoIlNiJuhrqnaFQjE-E3iltf_PDzSxQRFvavI4dJYX8dofzNLKDgmXLJ6iqfh9g7G-ny383JJp1ObKy-N876DPzimWrtdX4FAgBpA",
    "expires_in": 3600,
    "refresh_expires_in": 0,
    "token_type": "Bearer",
    "not-before-policy": 0,
    "scope": "email profile"
}

 

 

POST Data Reception

Info

Com o With the generated token gerado, é necessário passá-lo no authorization da chamada /consents, para obter o consentimento e informações do usuário, conforme modelo abaixo., it is necessary to pass it in the authorization of the call /consents , to obtain the user's consent and information, according to the model below.

 

Panel
bgColor#F4F5F7

https://api-smartkeys.celcoin.dev.fsapps.io/api/smart-keys/data-reception/v1/consents

 

Code Block
curl --location 'https://api-smartkeys.engdev.fsapps.io/api/smart-keys/data-reception/v1/consents' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OEhCYTFqdlZPMGVVcDl6aW5ldmJVaG9uSlI2cEJsOHBoQnVsSXAwIn0.eyJleHAiOjE2ODA2MjE3OTIsImlhdCI6MTY4MDYxODE5MiwianRpIjoiNmMyMjAyMjUtOTJlZS00YTFkLWE3MGUtMWFjZGZmNDE3OGI4IiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5mdWxsLWRldi5maW5hbnN5c3RlY2guY29tLmJyL2F1dGgvcmVhbG1zL3NtYXJ0LWtleXMiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiOTEzYTBmZjYtNjE4Yy00NDM3LWE0ZWUtMmU0ZmQyYzVmMDU4IiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiZTE5ODdlYzUtMjU2Ny00MDQ4LWFjZTktNmU2ZDdiOWY3N2ZjIiwiYWNyIjoiMSIsInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsImRlZmF1bHQtcm9sZXMtc21hcnQta2V5cyIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiZTE5ODdlYzUtMjU2Ny00MDQ4LWFjZTktNmU2ZDdiOWY3N2ZjIjp7InJvbGVzIjpbInVtYV9wcm90ZWN0aW9uIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6ImVtYWlsIHByb2ZpbGUiLCJjbGllbnRJZCI6ImUxOTg3ZWM1LTI1NjctNDA0OC1hY2U5LTZlNmQ3YjlmNzdmYyIsImNsaWVudEhvc3QiOiIxMC4yNDAuMC4xMCIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic2VydmljZS1hY2NvdW50LWUxOTg3ZWM1LTI1NjctNDA0OC1hY2U5LTZlNmQ3YjlmNzdmYyIsImNsaWVudEFkZHJlc3MiOiIxMC4yNDAuMC4xMCJ9.fRaM_i2uIohrN8WcOmlD4M3bJf4lu8zEtKKNv3dW9xiP2QmvDTCX3LIgcwakMFTahjZdIJFK95ioaEPvQpLK38QXAKJPMfzEjar39ruUNth4pqiE8iPBGTV4lNSIMArMI-pgBOpJCr2lLDfKnjvrkIqf1rrnCGdZc8UhpxkJtbtFBVDlvQBnFp-N_KiKyYIIvUvEqzHxetag9W715b9DqoDynHp_Pf7kkk1g5P4U7cQjKlKAYNoIlNiJuhrqnaFQjE-E3iltf_PDzSxQRFvavI4dJYX8dofzNLKDgmXLJ6iqfh9g7G-ny383JJp1ObKy-N876DPzimWrtdX4FAgBpA' \
--header 'Content-Type: application/json' \
--data '{
  "data": {
    "loggedUser": {
      "document": {
        "identification": "

...

02*****94*66",
        "rel": "CPF"
      }
    },
    "permissions": [
            "ACCOUNTS_READ",
						"ACCOUNTS_OVERDRAFT_LIMITS_READ",
						"ACCOUNTS_BALANCES_READ",
						"ACCOUNTS_TRANSACTIONS_READ",
						"CREDIT_CARDS_ACCOUNTS_BILLS_READ",
						"CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ",
						"CREDIT_CARDS_ACCOUNTS_LIMITS_READ",
						"CREDIT_CARDS_ACCOUNTS_READ",
						"CREDIT_CARDS_ACCOUNTS_TRANSACTIONS_READ",
						"CUSTOMERS_PERSONAL_ADITTIONALINFO_READ",
						"CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ",
						"LOANS_READ",
						"LOANS_WARRANTIES_READ",
						"LOANS_SCHEDULED_INSTALMENTS_READ",
						"LOANS_PAYMENTS_READ",
						"FINANCINGS_READ",
						"FINANCINGS_WARRANTIES_READ",
						"FINANCINGS_SCHEDULED_INSTALMENTS_READ",
						"FINANCINGS_PAYMENTS_READ",
						"UNARRANGED_ACCOUNTS_OVERDRAFT_READ",
						"UNARRANGED_ACCOUNTS_OVERDRAFT_WARRANTIES_READ",
						"UNARRANGED_ACCOUNTS_OVERDRAFT_SCHEDULED_INSTALMENTS_READ",
						"UNARRANGED_ACCOUNTS_OVERDRAFT_PAYMENTS_READ",
						"INVOICE_FINANCINGS_READ",
						"INVOICE_FINANCINGS_WARRANTIES_READ",
						"INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ",
						"INVOICE_FINANCINGS_PAYMENTS_READ",
						"RESOURCES_READ"
    ],
    "expirationDateTime": "2023-12-31T00:00:00Z"
  },
  "brandId": "95dd24d2-902e-49e1-ad0d-e02d938447ba",
  "redirectUri": "https://smart-keys.finansystech.com.br:8080/callback"
}'

 

Response:

Code Block
{
    "authorizationUrl": "https://openfinance.dev.fbank.opb.obm.engdev.fsapps.io/orgs/finansystech/auth?client_id=xcFd-8KjONJT2FCEHCnTK&scope=openid%20consent%3Aurn%3Afinansystech-dev%3A173d2e64-b51c-40f3-89f6-a04b429bbd33%20accounts%20credit-cards-accounts%20customers%20loans%20financings%20unarranged-accounts-overdraft%20invoice-financings%20resources&response_type=code%20id_token&redirect_uri=https%3A%2F%2Fsmartkeys-ui.engdev.fsapps.io%2Fcallback&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3AJtyZkiseLta9akkCRRpCT"
}

 

 

Tip

GET Authorization URL

...

-

...

Journey Demo

...

simulation

Info

After the user's definitions regarding the data they want to share and the sharing period, we must obtain the redirection URL for the login at the transmitter, where the interaction_id for the login is obtained, according to the model below.

 

Panel
bgColor#F4F5F7

https://openfinance.dev.fbank.opb.obm.engdev.fsapps.io/orgs/finansystech/auth?client_id=xcFd-8KjONJT2FCEHCnTK&https://openfinance.dev.fbank.opb.obm.engdev.fsapps.io/orgs/finansystech/auth?client_id=https://onboard.smartkeys.engdev.fsapps.io/api/portal/onboard/v1/reception

 

Code Block
curl --location 'https://openfinance.dev.fbank.opb.obm.engdev.fsapps.io/orgs/finansystech/auth?client_id=xcFd-8KjONJT2FCEHCnTK&scope=openid%20consent%3Aurn%3Afinansystech-dev%3Ae119d330-4e42-4f9b-ae25-8fabb53de785%20accounts%20credit-cards-accounts%20customers%20loans%20financings%20unarranged-accounts-overdraft%20invoice-financings%20resources&response_type=code%20id_token&redirect_uri=https%3A%2F%2Fsmartkeys-ui.engdev.fsapps.io%2Fcallback&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3AkdDMUphtJfrVHFm4nC-5H'

 

Response:

Code Block
Redirecting to <a
	href="dev://login?interactionId=fqj1QZggYAkaFszue4TE1">dev://login?interactionId=fqj1QZggYAkaFszue4TE1</a>.

 

POST Login

Info

Esta etapa corresponde a recepção do usuário no ambiente da instituição transmissora dos dados selecionada, onde é necessário passar um username e um password, no body, para a devida autenticação do cliente, conforme cURL do modelo abaixo.

This step corresponds to the reception of the user in the environment of the institution transmitting the selected data, where it is necessary to pass a username and a password, in the body, for the proper authentication of the client, according to the cURL of the model below.

 

Panel
bgColor#F4F5F7

https://api-openfinance.dev.fbank.opb.obm.engdev.fsapps.io/api/finansystech/consents/v1/interactions/{{login_interaction_id}}/login

 

Code Block
curl --location 'https://api-openfinance.dev.fbank.opb.obm.engdev.fsapps.io/api/finansystech/consents/v1/interactions/fqj1QZggYAkaFszue4TE1/login' \
--header 'Content-Type: application/json' \
--data '{
    "username": "user01",
    "password": "88888888"
}'

 

Response:

Code Block
{
    "url": "dev://consent?interactionId=OYA8aYddGDpI4KKFFJqkx&kind=DATA",
    "token": {
        "id_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJKMEEweHRVSy1EQmxobEhEYVppRWhucGhqSXhMc2RBNFpXR01lQzBjZm80In0ey****OiJ******5cCIgOiAiSldU******ICJKMEEweHRVSy1EQmxobEhEYVppRWhucGhqSXhMc2RBNFpXR01lQzBjZm80In0.eyJleHAiOjE2ODA2MTg5NTgsImlhdCI6MTY4MDYxODY1OCwiYXV0aF90aW1lIjowLCJqdGkiOiI3NjFmY2NmNC1jM2IyLTRjYTktODc4Yy01MTkwZDIyMmIxZjUiLCJpc3MiOiJodHRwczovL2tleWNsb2FrLnNoZC5lbmdkZXYuZnNhcHBzLmlvL2F1dGgvcmVhbG1zL2ZpbmFuc3lzdGVjaC1vcGVuYmFua2luZy1kZXYiLCJhdWQiOiJmaW5hbnN5c3RlY2giLCJzdWIiOiI1ZjAxZWZjOC0yZjJkLTRhNjQtOTJiMC0zOWNlOGU1YTgxODIiLCJ0eXAiOiJJRCIsImF6cCI6ImZpbmFuc3lzdGVjaCIsInNlc3Npb25fc3RhdGUiOiI3ZGE4OGE4Yy04ZTk5LTQwMTUtYjlmYS03YmUzYzNlNWMzOGMiLCJhdF9oYXNoIjoiU0xlUnpkUXJnSGNyYU9Qckl0ZmdHUSIsImFjciI6IjEiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImNwZiI6IjAyOTgxOTk0MTY2IiwicHJlZmVycmVkX3VzZXJuYW1lIjoidXNlcjAxIn0.EfAF3RRzYTgP3ZNtmfUgNVIV7WCSQdnwxxRp0wXZneSpvpF7pLNYlHYz9FIMir5tX3-QKDJz-IDGpvl_N5W3ZJ1oJWXvLG73jqt9q2Ocjz-UxFdFw_wFa2qhoOB2hSkhTi35I9DBcj3WnRU69ZiNh_5QozyKyTcq_rYlQp3LV728mus-JdyjGsQycrHT_5I1bXhp9Zb5O42znQO746l_SWlQCxvhXlRnkX0awnYl2LW65TY4zAJ1WMgshZ40A-E31FpgQVJd1BvQ4GCW0rWFwsIIgW8Xq5iikjzl3S7V54q34T-CLfVukN_MIfj_u8YKyirtF6th8jpu2yDevwjkWQ",
        "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJKMEEweHRVSy1EQmxobEhEYVppRWhucGhqSXhMc2RBNFpXR01lQzBjZm80In0eyJ*1NiIs***I***C*****iSldUIiwia******MEEweHR****EhEYVppRWhucGhqSXhMc2RBNFpXR01lQzBjZm80In0.eyJleHAiOjE2ODA2MTg5NTgsImlhdCI6MTY4MDYxODY1OCwianRpIjoiZDIwZWMwNWMtMzcwMi00NGRmLTg2MGQtZTFjNjhmMWVjYmQ2IiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5zaGQuZW5nZGV2LmZzYXBwcy5pby9hdXRoL3JlYWxtcy9maW5hbnN5c3RlY2gtb3BlbmJhbmtpbmctZGV2IiwiYXVkIjoiYWNjb3VudCIsInN1YiI6IjVmMDFlZmM4LTJmMmQtNGE2NC05MmIwLTM5Y2U4ZTVhODE4MiIsInR5cCI6IkJlYXJlciIsImF6cCI6ImZpbmFuc3lzdGVjaCIsInNlc3Npb25fc3RhdGUiOiI3ZGE4OGE4Yy04ZTk5LTQwMTUtYjlmYS03YmUzYzNlNWMzOGMiLCJhY3IiOiIxIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCJkZWZhdWx0LXJvbGVzLWZpbmFuc3lzdGVjaC1vcGVuYmFua2luZy1kZXYiXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6Im9wZW5pZCBlbWFpbCBwcm9maWxlIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJjcGYiOiIwMjk4MTk5NDE2NiIsInByZWZlcnJlZF91c2VybmFtZSI6InVzZXIwMSJ9.P900CxQNxoujSwICkgHpVOTdUHpy5o4YQO3aDV_EuCweiQVEkgy-Sizjxk2eG5znIlwGHho9EHMRGp2lm-tUjRyeO7xiTS9x_dYgdFZFXeAn7ekxsdUPQEX2ayF38r0uic-V2HriUjqJt2zTm7SyT-5iZMEWUjSk5XEUJD3DSun0ZQdq522QiEwMkOLr2A_7mnOo6PMJ7eFXwIfH9OqYeCXHIsCtfgOIs1dieUJpNgZnkuJrgHTjMqRPP0cB6pQmyAucxwDza8HnmCc95vtGqLEg87Li1pJ_0edX0ZoFgWrvyACE7uvJ99S9jyW4kkWFmH5cisthSw13JCLQTTOcAg",
        "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MzMxZWY1Yi1hZTczLTQ2YjQtODhhNy0zODc4Njc0Mzg3NDUifQ.eyJleHAiOjE2ODA2MjA0NTgsImlhdCI6MTY4MDYxODY1OCwianRpIjoiZjRiMTQ0NjgtODllOC00ZTM1LTk3MjQtYWJjMzNlODU4ZjhmIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5zaGQuZW5nZGV2LmZzYXBwcy5pby9hdXRoL3JlYWxtcy9maW5hbnN5c3RlY2gtb3BlbmJhbmtpbmctZGV2IiwiYXVkIjoiaHR0cHM6Ly9rZXljbG9hay5zaGQuZW5nZGV2LmZzYXBwcy5pby9hdXRoL3JlYWxtcy9maW5hbnN5c3RlY2gtb3BlbmJhbmtpbmctZGV2Iiwic3ViIjoiNWYwMWVmYzgtMmYyZC00YTY0LTkyYjAtMzljZThlNWE4MTgyIiwidHlwIjoiUmVmcmVzaCIsImF6cCI6ImZpbmFuc3lzdGVjaCIsInNlc3Npb25fc3RhdGUiOiI3ZGE4OGE4Yy04ZTk5LTQwMTUtYjlmYS03YmUzYzNlNWMzOGMiLCJzY29wZSI6Im9wZW5pZCBlbWFpbCBwcm9maWxlIn0.Bw5Zo-qzLZenZj932N9ZzH2G9eyJhbG*zI1NiI****sIn*gOiA****iS*CI5MzMxZWY1Yi1h*****ZTczLTQ2YjQtODhhNy0zODc4Njc0Mzg3NDUifQ.eyJleHAiOjE2ODA2MjA0NTgsImlhdCI6MTY4MDYxODY1OCwianRpIjoiZjRiMTQ0NjgtODllOC00ZTM1LTk3MjQtYWJjMzNlODU4ZjhmIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5zaGQuZW5nZGV2LmZzYXBwcy5pby9hdXRoL3JlYWxtcy9maW5hbnN5c3RlY2gtb3BlbmJhbmtpbmctZGV2IiwiYXVkIjoiaHR0cHM6Ly9rZXljbG9hay5zaGQuZW5nZGV2LmZzYXBwcy5pby9hdXRoL3JlYWxtcy9maW5hbnN5c3RlY2gtb3BlbmJhbmtpbmctZGV2Iiwic3ViIjoiNWYwMWVmYzgtMmYyZC00YTY0LTkyYjAtMzljZThlNWE4MTgyIiwidHlwIjoiUmVmcmVzaCIsImF6cCI6ImZpbmFuc3lzdGVjaCIsInNlc3Npb25fc3RhdGUiOiI3ZGE4OGE4Yy04ZTk5LTQwMTUtYjlmYS03YmUzYzNlNWMzOGMiLCJzY29wZSI6Im9wZW5pZCBlbWFpbCBwcm9maWxlIn0.Bw5Zo-qzLZenZj932N9ZzH2G9_8sdwgfwGzCX6JriR4",
        "expires_in": 300,
        "refresh_expires_in": 1800,
        "token_type": "Bearer",
        "scope": "openid email profile"
    },
    "interactionId": "OYA8aYddGDpI4KKFFJqkx",
    "consent": {
        "permissions": [
            "ACCOUNTS_READ",
            "ACCOUNTS_OVERDRAFT_LIMITS_READ",
            "ACCOUNTS_BALANCES_READ",
            "ACCOUNTS_TRANSACTIONS_READ",
            "CREDIT_CARDS_ACCOUNTS_BILLS_READ",
            "CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ",
            "CREDIT_CARDS_ACCOUNTS_LIMITS_READ",
            "CREDIT_CARDS_ACCOUNTS_READ",
            "CREDIT_CARDS_ACCOUNTS_TRANSACTIONS_READ",
            "CUSTOMERS_PERSONAL_ADITTIONALINFO_READ",
            "CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ",
            "LOANS_READ",
            "LOANS_WARRANTIES_READ",
            "LOANS_SCHEDULED_INSTALMENTS_READ",
            "LOANS_PAYMENTS_READ",
            "FINANCINGS_READ",
            "FINANCINGS_WARRANTIES_READ",
            "FINANCINGS_SCHEDULED_INSTALMENTS_READ",
            "FINANCINGS_PAYMENTS_READ",
            "UNARRANGED_ACCOUNTS_OVERDRAFT_READ",
            "UNARRANGED_ACCOUNTS_OVERDRAFT_WARRANTIES_READ",
            "UNARRANGED_ACCOUNTS_OVERDRAFT_SCHEDULED_INSTALMENTS_READ",
            "UNARRANGED_ACCOUNTS_OVERDRAFT_PAYMENTS_READ",
            "INVOICE_FINANCINGS_READ",
            "INVOICE_FINANCINGS_WARRANTIES_READ",
            "INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ",
            "INVOICE_FINANCINGS_PAYMENTS_READ",
            "RESOURCES_READ"
        ],
        "creationDateTime": "2023-04-04T14:23:25.358Z",
        "status": "AWAITING_AUTHORISATION",
        "statusUpdateDateTime": "2023-04-04T14:23:25.358Z",
        "expirationDateTime": "2023-12-31T00:00:00.000Z",
        "loggedUser": {
            "document": {
                "identification": "02981994166",
                "rel": "CPF"
            }
        },
        "kind": "DATA",
        "fapiInteractionId": "9904315d-0dc1-4eb0-8199-07b2e6915b5d",
        "applicantId": "248cce08-0abc-4cdb-ba14-02cca03e5c74",
        "applicantSoftwareId": "decc6905-1d79-42cd-91aa-d5d0d12a8539",
        "events": [
            {
                "date": "2023-04-04T14:23:25.358Z",
                "event": "AWAITING_AUTHORISATION"
            },
            {
                "date": "2023-04-04T14:24:25.592Z",
                "event": "REDIRECTED"
            }
        ],
        "consentId": "urn:finansystech-dev:e119d330-4e42-4f9b-ae25-8fabb53de785",
        "consentTerm": 8,
        "consentTermUnit": "M",
        "organizationName": "Finansystech Dev",
        "organizationLogo": "https://finansystech-pub.s3.sa-east-1.amazonaws.com/f_logo.svg"
    }
}

 

POST Approve

Info

Nesta etapa é feita a aprovação do consentimento da transmissora junto a receptora, conforme modelo abaixo.

In this step, the consent of the transmitter is approved with the receiver, according to the model below.

 

Panel
bgColor#F4F5F7

https://api-openfinance.dev.fbank.opb.obm.engdev.fsapps.io/api/finansystech/consents/v1/interactions/{{consent_interaction_id}}/consent

 

Code Block
curl --location 'https://api-openfinance.dev.fbank.opb.obm.engdev.fsapps.io/api/finansystech/consents/v1/interactions/OYA8aYddGDpI4KKFFJqkx/consent' \
--header 'Authorization:

...

 Bearer eyJhbGc******iIsInR*dUIiwia2lk*****IiA6ICIwMTQ*A1LTRlYzkt****YWY3My0wM2UzOGNiNmIwNGUifQ.eyJleHAiOjE2NzgyOTMzNTMsIm5iZiI6MCwiaWF0IjoxNjc4MjkzMDUzLCJwZXJtaXNzaW9ucyI6W3sicnNpZCI6IjVjYzI1OTZiLTkyMWQtNGY4ZC1hMDg0LWE5ZDExMDA1NTBkMCJ9XSwianRpIjoiNDU5MTNjOWQtYTA2Mi00M2FiLTlhMmUtMWJjY2FiMzA2MTUzLTE2NzgyOTMwNTUzNDEiLCJhdWQiOiJodHRwczovL2tleWNsb2FrLmZ1bGwtZGV2LmZpbmFuc3lzdGVjaC5jb20uYnIvYXV0aC9yZWFsbXMvc21hcnQta2V5cyIsInN1YiI6ImM4OTJkYjViLTUyMDktNDBhOS1iNGQwLTdjMmM4MzViYWM0OCIsImF6cCI6ImNlbGNvaW4ifQ.jk2NIr7t67BCaPhuw1K6QTQD_5XrBCHZbjxrde68bJk' \
--header 'Content-Type: application/json' \
--data '{}'

 

Response:

Code Block
{
    "url": "https://smartkeys-ui.engdev.fsapps.io/callback#code=NMQTZ0kozAW3nMC1MLn9xgrMPlnke6gG6_rgOYJXPoc&id_token=eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00iLCJjdHkiOiJKV1QiLCJraWQiOiI3OGRhY2UyZDEzZTlkYzk2ZDJkYTBlNTM3YjBmZTNjNDliZThiZTc1MDdkNmUwMmQ4NDIwNGU1ZGQxNTliMDI5In0.XZ53Uim_gmJTjbj1r9oIsOPsdSXEHrxUOS1V-KegTY3QViknqLb50usmnzQuG7PGoF4Y9UKL4WKs9S6mw_NjPhsYErCQxAooQSBoIxRtw6eqHqBpUeQMEmlpwgIBvxJSlKQHohjOhn8CULpVbqOiBWTElidmUvtx17spJmZyBjHLQ55t1IWwBi3Zjiw6vMli_jwjFzjhPOCIu1qvmcAOVKyNlWyHOCWfFTuBufaOWXNN3XpxT5DmbfHXPXN9PLx0zNEk94T5UlEsspI2n3wtLVyn3h7BOMZ6Mg9_xM4wB-JoFX3bC_cbvdTVgSDJRGkrzN4esFnMckMqgrTFZCsRzw.gzZsNza3-WH_llpX.cCde14K2yHZYIyPuvwLT2-eU8cS0lJKa7A_d_KfOwc5wd4bStP3YZJU3lpxVHOs4aWd25DZ-ziy6xzPrwVC5t7PmEhM9sp9q7nyOY6tfyi-DKIQ8DiviU1fYEvsPs3mYbxU0qfr30Hyh8UJydSdcajlh12h9O6Qd1O4zbbQgwkc5MlUpvzpcYi0DA5DfiIy2hgEo_DduM5kwxAexOsCbQ_wpxOYj8rzbXlWfgeDw2G74WLbGnEHaRw0n72bLdyKTYtbyH1Z_e3D_vYfctHwnTkk9hOu3ZZIdYbxh2sdJwtb_dcPbkj5M6BSPfxTJDEhxtnn28AjBlaQIbSQMVKexvv3DFkDiP9g0b1gBv0SYv3BiFThaj_SIJJY-uGJ8BrUO7JVuOAS95Q5t5I3CAON_W6XNbPM_OizpV4GF8QV0iKsuIvEawp9HoC1sihqCIJLw7BClynE1FlUaNXYGyTkN6YEMhQDfWzo75BvV9-RUrSpqbpkflhpbwBqa5xazwToGeinWQPUleQVFI_0wBfqN-Th7EiYbOhlbjhmGkrvzozyTBGPWC-KiP7GfBRo1BsAKfQAcjIYtbkn_idxFgWAPvWZLvFki-23EzpHMzh3X41AjBtyjFOBNB3m2JFqCxECXPqrM7A7CAJkpMLoFLnaEOF13lRH2-uZXihc-BQWQQgjSt4velYXc3CuYzllSFkNj4vJxQiwh5Dba1rJhYd_fhDFNzjNQXdyfCgW4ITnkboaPFOskz3sNTB8gnbP0dfvyq3V03MBUVYn6_D8rDy8TX8q5Y1iLnNo_VCI0nWW4s-ZTIb76oZcqDLIb2R0afBsk-6cF3AbPQuq892tNGUADEQoat7eM3kQ_N5WJ9_AQ0XHsewtZzmd1fgqdSzxoSbgHQgt5A2hsqrUedzJoCC4zksWUSG9i7BRJs4W2YN62uaP9-HP1nCkr9Yyp63-_I0k3vMLT826eGA4G5aZWDTUkO2g2TByF-5MNE0o7SuGkFXrvNJh-Bmy1tfE1sqC3pIjkIAJdex6SOUzuc7mA6C44o01FCGw__8_N_8d-nK8_1c6xkcxkf-6VFXEpu6wlO4pBrg0gq29_6ZLDCR7QHeSudh3xEiPk1jAV022G9deQkpLts2-4KZ1MdII098Pt1gIh2OjmHWZGWzdMABLndVu6mlXVKw_2xWj3aVGpyHxm0bEaCXydRobkfFyeZraU_w.ubhTow16VKiZ-uYaBCFeMQ&state=gX7Q66xntGCEB6IKxTBftDO7eC6S6-vIIEZ1n95axTY"
}

 

 

POST Callback

Info

Após a etapa de confirmação do usuário no ambiente da instituição transmissora, é retornado o callback da transação, conforme modelo abaixo. After the user confirmation step in the transmitting institution's environment, the transaction callback is returned, according to the model below.

 

Panel
bgColor#F4F5F7

https://api-smartkeys.celcoin.dev.fsapps.io/api/smart-keys/data-reception/v1/consents/callback

 

Code Block
curl --location 'https://api-smartkeys.engdev.fsapps.io/api/smart-keys/data-reception/v1/consents/callback' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OEhCYTFqdlZPMGVVcDl6aW5ldmJVaG9uSlI2cEJsOHBoQnVsSXAwIn0.eyJleHAiOjE2NzkwNzI4NzQsImlhdCI6MTY3OTA3MjU3NCwianRpIjoiNjZkY2ZjZWEtOTBlNS00NWJkLTkxNWQtOTU4YjQxYjRkNjk3IiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5mdWxsLWRldi5maW5hbnN5c3RlY2guY29tLmJyL2F1dGgvcmVhbG1zL3NtYXJ0LWtleXMiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNmRiZjJlOWMtMmUyMy00ZGMyLTg1NTItNTQ5MmY5NjAyMWZlIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiNTEzYTdlYmUtNWRhZi00ZDI5LTlmN2QtMGYyZWMyNjEwY2ExIiwiYWNyIjoiMSIsInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsImRlZmF1bHQtcm9sZXMtc21hcnQta2V5cyIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiNTEzYTdlYmUtNWRhZi00ZDI5LTlmN2QtMGYyZWMyNjEwY2ExIjp7InJvbGVzIjpbInVtYV9wcm90ZWN0aW9uIl19LCJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6ImVtYWlsIHByb2ZpbGUiLCJjbGllbnRJZCI6IjUxM2E3ZWJlLTVkYWYtNGQyOS05ZjdkLTBmMmVjMjYxMGNhMSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiY2xpZW50SG9zdCI6IjEwLjI0MC4wLjciLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJzZXJ2aWNlLWFjY291bnQtNTEzYTdlYmUtNWRhZi00ZDI5LTlmN2QtMGYyZWMyNjEwY2ExIiwiY2xpZW50QWRkcmVzcyI6IjEwLjI0MC4wLjcifQ.dDprl4ilm2CxIQ22IhMicpU9HMY8DH791afxOiMxH1vMGrZJclFFWzmvNte3uxyW6aI72DhDDBLtOv3dy9oZKnhl7eHnHqpGHwNRypYTZUfwmGKzLsU_8WCN7ugvUm-AyHOX3VSb4VCslcM8F5HBREOLGFi6CDGW0u9YbJtcCyOyL57uSTV_RkzQZpgWBZsL632mnnFwjYR0syKTvSgpUASI3zjBGOawzRDzBAZzBEokXDuO18IzVDSAbqxIwsyqapRaRQE8XoG6ggnszLjnXpKQAxXj-fLdU_tMS_NcGjQ9KVthudWMVszSp1Gv8NYCPNr65dRZFiv4erN8Is--4Q' \
--header 'Content-Type: application/json' \
--data '{
    "code": "C7qxvtgQruwz6JIDq5n1S_sc0TeNwkvwnHAjbaPXtaX",
    "id_token": "

...

eyJhbG*****0EtT0FFUCI*HQ00iLCJjdHkiOi****JK*3OGRhY2UyZDEzZ****TlkYzk2ZDJkYTBlNTM3YjBmZTNjNDliZThiZTc1MDdkNmUwMmQ4NDIwNGU1ZGQxNTliMDI5In0.Iu6Bj1rzP2y-F1ZMmGIbfhXHMF9wQJm-EXq8qnaWdtF7KC3zxJ4EQDqWEQCsSkmgzXg_5fhkh63yqH7tThUB8AxBLOhMIXYgCQJ5ifAXEW5tlPstSkrq8VxEOtejGii4rgdV2jnPVLsi5SmIW2c9oDI7hJCdGgXDYnzX6MUwRhuxpAze5AzWn-i9a-kIJt8QpyvjKItVEWgOPLFZ7ZRfLY_YF7zBaugAPEC-Wng02EGVCgFsn9oGIjLGcOQ4p98z90vO77_sYOemP54hPaqTpdpUDWMw9pYoid-pPqXAL1kS-_RoZPGkk9v3JfWhHPxtasdDxmrcg9M3XqAKorLuLw.RxOIZxxjPm_W0DXK.1MaMV3XSrAtITJa8Z_a7ys4GuUJtjRVeXNmb5O1V6GtQSq5k4xXXnLnjK3z_scpftXjJ8jEMljea0qjL0hSq0xdJhMIhJkM9lzPHMV_kvJJ-nro8bCwy03eRnvDbEa3mNBRe2LE2j7zkBFH0XSkX9pdv60nnIEvqw3xzpIofQ5YH7cw6t5Taxx-6GmU2c4NMvZYfvK82AP746bCr2wsZxgS72vlriAlBd0TfGtUXJoiT-0tgmlk_gTDmWbO4VF74vnGt6g75dPHj8RXBy4iFwTdws2Bhb9gjH8K6uQOLHF6ciTlX_x0hW2jqXu4lCL4zeFX5yibg-cRhjxnInajWoE35SjsRO1i6lOxHOyrIdNq9BSFx_B6pdEQUXNpi_OOEkb0x3gBADBAlj3fIVEWGJcFGg1brgtRvUtSeP6_PZ564x9B7-8K9aDJ3BhY4c8pMxvrWp_HPDhjdgzrqv1dAyy_UXdTxB_UPjNtawy_5LE9lnA8g57YGGQ4shPj0QTdRwI3l0Z7qI7c5HsfbXmDfkR3IeXtmuS0J_3xDvMIajGvNwXAGXc7laNlsg5uyLApm0h-NRMf5pRWSEadB1pkkSXBM9efNLIjYYU9ZO6nmW5jZ4CnUpPMnDLqm72PjiveB9yVlpHldiMaGrfcClaBmVsMgQ8H0pth-0Y5NBubYJrlvzChLbnpjedX1GctYUCwk5LrhCqRzkf7odE_2Zuo3P6OPt8pkoyHm23IIVG4S7IBy7z7E8GQ7pJLp-lJjZU9G0t7RSbzDGEMKCgRLEHxlsI9r7yeh4YnhGMY4_gUZQR5ALB3OdM6lPva_r75VACmDHYQl3aGaiW6KCuFbS2_2p5LrbM8evmFUtuD0CKmXNgn15KWIJO4RGuFq8kfM04UaRi0TOITK3AfnemLdIZoM_A2kaC5IiMBPjkvUMX99TXPGYlbFt1VWi6-DtX0Dv-49gbLQ74mGPYM8G_yCdOc-ljirYPKoEPZ6K86mlgyWE7nCVsjiwoduACJWdmxRv_raBfw1nTVsCkm396ImQHp4IxxMv9ozozr_3uxIFC8EPKu3t-OtCA-4_puZOLbE7272WkGYC1zR1FtrM5iTFFUrqdbYBaA8yQ6qbz0AOOv1kILRwwcemqxIRrjVrEDgp7PefsZMPcr48EHz0sLjNETmSqh67pkVEdRpZnKWAQ_7VY3TuoBWTqsBawuQuI1t0Q.auZ11KMxKSAVwEOybCVx4Q",
    "state": "lPOOqD1D-Fjndvnt63moETZVIiTqpFRf4EVOFtATXuE"
}'

 

Tip

Response

Code Block
{
    "url": "https://smartkeys-ui.engdev.fsapps.io/callback?ticket=eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwMTQ4ZjkxZS01NjA1LTRlYzktYWY3My0wM2UzOGNiNmIwNGUifQ.eyJleHAiOjE2ODA2MjU0MjUsIm5iZiI6MCwiaWF0IjoxNjgwNjIxODI1LCJwZXJtaXNzaW9ucyI6W3sicnNpZCI6IjNlN2Q4NTMxLWQ4MjMtNDg1Ny04NjZiLTZmMTg2OTMyNWY4NiJ9XSwianRpIjoiZjQzYTgzZWYtMGE0MC00ZTgyLThiOWMtZjhiZGFiNjM2ZWZiLTE2ODA2MjE4NTAwODMiLCJhdWQiOiJodHRwczovL2tleWNsb2FrLmZ1bGwtZGV2LmZpbmFuc3lzdGVjaC5jb20uYnIvYXV0aC9yZWFsbXMvc21hcnQta2V5cyIsInN1YiI6ImM4OTJkYjViLTUyMDktNDBhOS1iNGQwLTdjMmM4MzViYWM0OCIsImF6cCI6ImNlbGNvaW4ifQ.nhW9PVOlHE2sgzy4iU2MeqOi_QDAjI0rAf2isytNmXw&state=lPOOqD1D-Fjndvnt63moETZVIiTqpFRf4EVOFtATXuE"
}

 

Warning

Response

...

to error scenario

 

>>>>> inserir o Json para o cenário de erro<<<<<<insert the Json for the error scenario<<<<<<

 

Image Removed

Note

...

ATENÇÃO: após receber um retorno de um token dentro da tag “ticket”, você deve inseri-lo na próxima chamada de resources para obter os dados de retorno consentidos do usuário, conforme modelo abaixo.

ATTENTION: after receiving a return of a token inside the “ticket” tag, you must insert it in the next resource call to obtain the consented return data from the user, according to the model below.

 

...

 

 

Tip

GET Resources

Code Block
curl --location --request GET 'https://api-smartkeys.celcoin.dev.fsapps.io/api/smart-keys/data-consumer/v1/consume?link=%2Fopen-banking%2Fresources%2Fv1%2Fresources' \
--header 'Authorization:

...

 Bearer eyJhbG*****NiIsInR5cCIgOiA*a2lkIiA6****ICIwMTQ4Z*jA1LTRl****zktYWY3My0wM2UzOGNiNmIwNGUifQ.eyJleHAiOjE2ODA2MjU0MjUsIm5iZiI6MCwiaWF0IjoxNjgwNjIxODI1LCJwZXJtaXNzaW9ucyI6W3sicnNpZCI6IjEwMmJiMDk5LWQ3NmEtNDVjNS04ZmM3LTBjNzI2MzZiN2NlZSJ9XSwianRpIjoiZjNlYTI3YmQtNWMwMC00YWNjLWE2NTMtOGRmNzg0YWZiYWU5LTE2ODA2MjM1MjI1NjciLCJhdWQiOiJodHRwczovL2tleWNsb2FrLmZ1bGwtZGV2LmZpbmFuc3lzdGVjaC5jb20uYnIvYXV0aC9yZWFsbXMvc21hcnQta2V5cyIsInN1YiI6ImM4OTJkYjViLTUyMDktNDBhOS1iNGQwLTdjMmM4MzViYWM0OCIsImF6cCI6ImNlbGNvaW4ifQ.38r_D1AG_yx_0gFPBsXPZrQ0aLWP8HR0eLE-yVXmIP4&state=TwL_t-GGukgNSUMeBhMj06GAOYMXLehIfILkKgkf9HI' \
--header 'Content-Type: application/json' \
--data '{}'

 

Image Removed

Info

Após esta etapa, basta chamar a API no agregattor

...

Note

...

ATENÇÃO: é necessário passar o token recebido dentro do ticket da chamada anterior de /callback, no authorization da chamada de /resources para obter os dados de retorno consentidos do usuário, conforme modelo abaixo.

ATTENTION: it is necessary to pass the token received inside the ticket of the previous /callback call, in the authorization of the /resources call to obtain the user's consented return data, according to the model below.

 

...

 

Info

After this step, just call the API on the aggregator

 

...