Create Allowed Redirect URL
POST
/public/v3/allowed-redirect-urls
The endpoint is to register URLs that we will use to redirect the customer from their online banking provider to your application.
You must use this endpoint to register redirect URLs for your web application or if you are building an Android with App Links or iOS app with Universal Links to redirect the customer back to your mobile application.
For mobile applications with custom scheme please use our Android or iOS SDK.
We will redirect the customer to your application with a GET request, containing the query parameters listed below:
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| status | string | yes | Success if the customer successfully shared their online banking accounts. Error, otherwise |
| message | string | no | Additional description if status is error |
| customer_id | string | yes | Customer ID |
| consent_id | string | yes | Bank Consent ID (provided in the response for creating the bank flow URL) |
| state | string | yes | Unique state of the operation (provided in the response for creating the bank flow URL) |
| bank_slug | string | yes | Bank slug |
none
none
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| url | string | yes | URL to which we will redirect the customer back to your application |
| comment | string | no | A description for the URL |
| Parameter | Data type | Required? | Description |
|---|---|---|---|
| allowed_redirect_url_id | int | yes | ID of the Allowed Redirect URL |
1
2
3
4
5
6
7
curl --location --request POST 'https://api.friendlyscore.com/public/v3/allowed-redirect-urls' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
"url": "http://localhost:8081/redirect",
"comment" : "Placeat pariatur sit fuga velit."
}'1
2
3
{
"allowed_redirect_url_id": 123456
}Was this article helpful?
Friendly Score UK Ltd.
84 Brook Street
London W1K 5EH
Call us on +44 20 3709 6726
Company registered in England
Company number 09168668, ICO ZA111687
VAT registration number 206 9758 80
Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)