Skip to main content
POST
/
v1
/
consents
Create a consent
curl --request POST \
  --url https://api.swippee.com/v1/consents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "report_id": "cl_abc123",
  "scopes": [
    "identity",
    "income",
    "verify"
  ],
  "grantee_label": "Nabil Bank loan desk",
  "expires_in_days": 30
}
'
{
  "id": "<string>",
  "token": "<string>",
  "data_url": "<string>",
  "scopes": [
    "<string>"
  ],
  "expires_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.swippee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Your API key from the dashboard, sent as Authorization: Bearer swippee_sk_live_....

Body

application/json
​
report_id
string
required
Example:

"cl_abc123"

​
scopes
enum<string>[]
required
Available options:
identity,
income,
liabilities,
verify,
transactions
Example:
["identity", "income", "verify"]
​
grantee_label
string
Example:

"Nabil Bank loan desk"

​
expires_in_days
integer
default:30
Required range: x <= 365

Response

Consent created

​
id
string
​
token
string
​
data_url
string
​
scopes
string[]
​
expires_at
string<date-time>