Apps

Create

post

Body

application/json

webhook_urlstringRequired

URL to be notified when consent status changes and data is ready.

Example: https://webhook.site/b28121f3-f837-4dfe-b3c9-2766f2ce67b0

Responses

201

Created

application/json

app_idstringRequiredExample: ki_vtchP3kysaWPULdt9jQG6TUdaXvoABuX

app_secretstringRequiredExample: ks_gy27edJXbgWeXBW8fAw3vHHVASyWTYx6

post

/v1/apps/

HTTPcURLJavaScriptPython

POST /v1/apps/ HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "webhook_url": "https://webhook.site/b28121f3-f837-4dfe-b3c9-2766f2ce67b0"
}

201

Created

{
  "app_id": "ki_vtchP3kysaWPULdt9jQG6TUdaXvoABuX",
  "app_secret": "ks_gy27edJXbgWeXBW8fAw3vHHVASyWTYx6"
}

Update

put

Authorizations

basicAuth

AuthorizationstringRequired

Username: Your App ID. | Password: Your App Secret.

Body

application/json

webhook_urlstringRequired

URL to be notified when consent status changes and data is ready.

Example: https://webhook.site/b28121f3-f837-4dfe-b3c9-2766f2ce67b0

Responses

200

OK

application/json

put

/v1/apps/

HTTPcURLJavaScriptPython

PUT /v1/apps/ HTTP/1.1
Host: localhost:8080
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "webhook_url": "https://webhook.site/b28121f3-f837-4dfe-b3c9-2766f2ce67b0"
}

200

OK

{
  "app_id": "ki_vtchP3kysaWPULdt9jQG6TUdaXvoABuX",
  "webhook_url": "https://webhook.site/b28121f3-f837-4dfe-b3c9-2766f2ce67b0"
}