Iswigo API reference

Users

Management of users.

Lot of API requests needs an ACCESS_TOKEN header value to works. So you need to create a user and authenticate him.

POST Create a user

Create a new user with an email and a password. Must be a valid email format, but not necessary a valid email.

We can not unblock an account where the email or the password would be forget.

Copy 
https://api.iswigo.com/v1/users

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Content-Type *
application/json

Body

Copy 
{
    "email": "hector.berlioz@iswigo.com",
    "password": "Str0ng!Passw0rd"
}

Examples

Create new user
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/users' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "email": "hector.berlioz@iswigo.com",
    "password": "Str0ng!Passw0rd"
}'
Response
201 Created Copy 
{
    "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
    "email": "hector.berlioz@iswigo.com",
    "last_name": null,
    "first_name": null,
    "company": null,
    "terms_of_service": null
}
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/users' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "email": "hector.berlioz@iswigo.com",
    "password": "Str0ng!Passw0rd"
}'
Response
409 Conflict Copy 
{
    "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
    "email": "hector.berlioz@iswigo.com",
    "last_name": null,
    "first_name": null,
    "company": null,
    "terms_of_service": null
}

POST Authenticate a user

Authenticate a user with email/password combinaison.

This generate an access token ; that you can use in some API request (identified in headers with ACCESS_TOKEN value).

Copy 
https://api.iswigo.com/v1/authenticate

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Content-Type *
application/json

Body

Copy 
{
    "email": "hector.berlioz@iswigo.com",
    "password": "Str0ng!Passw0rd"
}

Examples

Successful authentication
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/authenticate' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "email": "hector.berlioz@iswigo.com",
    "password": "Str0ng!Passw0rd"
}'
Response
200 OK Copy 
{
    "token_type": "Bearer",
    "expires_in": 3599,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ...1tH3O5QcwtezqQ9BfvKArwDpJSJ1IN9NkJ7XE7IcDTDef8"
}
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/authenticate' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "email": "hector.berlioz@iswigo.com",
    "password": "Str0ng!Passw0rd"
}'
Response
400 The provided authorizati ... Copy 
{
    "error": {
        "code": 400,
        "description": "The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client."
    }
}

GET Get users

Get list of all created users for your application.

Copy 
https://api.iswigo.com/v1/users

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request

Query parameters

range
0-19
Range of results

Examples

Get users
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/users' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}'
Response
200 OK Copy 
[
    {
        "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
        "email": "hector.berlioz@iswigo.com",
        "email_validation": "hector@berlioz.com",
        "last_name": null,
        "first_name": null,
        "company": null,
        "terms_of_service": null
    },
    ...
]

GET Get a user

Get the email, last name, first name and the company with the user id.

Copy 
https://api.iswigo.com/v1/users/:userId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request

Path variables

userId *
26f12881-9960-49b0-8d0c-2bb1530e703c
User ID

Examples

Get a user
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/users/26f12881-9960-49b0-8d0c-2bb1530e703c' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}'
Response
200 OK Copy 
{
    "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
    "email": "hector.berlioz@iswigo.com",
    "email_validation": "hector@berlioz.com",
    "last_name": null,
    "first_name": null,
    "company": null,
    "terms_of_service": null
}

PUT Edit a user email

Edit a user email. It's the email used for authentication.

You need the current user password.

Copy 
https://api.iswigo.com/v1/users/:userId/email

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Content-Type *
application/json

Path variables

userId *
26f12881-9960-49b0-8d0c-2bb1530e703c
User ID

Body

Copy 
{
    "email": "hector.berlioz@iswigo.com",
    "password": "Str0ng!Passw0rd"
}

Examples

Edit a user email
Request
Copy 
curl --location --request PUT 'https://api.iswigo.com/v1/users/26f12881-9960-49b0-8d0c-2bb1530e703c/email' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "email": "berlioz@iswigo.com",
    "password": "Str0ng!Passw0rd"
}'
Response
200 OK Copy 
{
    "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
    "email": "berlioz@iswigo.com",
    "last_name": null,
    "first_name": null,
    "company": null,
    "terms_of_service": null
}
Request
Copy 
curl --location --request PUT 'https://api.iswigo.com/v1/users/26f12881-9960-49b0-8d0c-2bb1530e703c/email' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "email": "berlioz@iswigo.com",
    "password": "Bad!Passw0rd"
}'
Response
400 Invalid user password Copy 
{
    "error": {
        "code": 400,
        "description": "Invalid user password"
    }
}

PUT Edit a user password

Edit a user password. It's the password used for authentication.

You need the current user password.

Copy 
https://api.iswigo.com/v1/users/:userId/password

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Content-Type *
application/json

Path variables

userId *
26f12881-9960-49b0-8d0c-2bb1530e703c
User ID

Body

Copy 
{
    "password": "Str0ng!Passw0rd",
    "new_password": "VeryStr0ng!Passw0rd"
}

Examples

Edit a user password
Request
Copy 
curl --location --request PUT 'https://api.iswigo.com/v1/users/26f12881-9960-49b0-8d0c-2bb1530e703c/password' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "password": "Str0ng!Passw0rd",
    "new_password": "VeryStr0ng!Passw0rd"
}'
Response
200 OK Copy 
{
    "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
    "email": "hector.berlioz@iswigo.com",
    "last_name": null,
    "first_name": null,
    "company": null,
    "terms_of_service": null
}
Request
Copy 
curl --location --request PUT 'https://api.iswigo.com/v1/users/26f12881-9960-49b0-8d0c-2bb1530e703c/password' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "password": "Bad!Passw0rd",
    "new_password": "VeryStr0ng!Passw0rd"
}'
Response
400 Invalid user password Copy 
{
    "error": {
        "code": 400,
        "description": "Invalid user password"
    }
}

DELETE Delete a user

Delete a user and all associate information, like bank account, documents...

Irreversible action! We cannot restore deleted accounts.

Copy 
https://api.iswigo.com/v1/users/:userId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

userId *
26f12881-9960-49b0-8d0c-2bb1530e703c
User ID

Examples

Delete a user
Request
Copy 
curl --location --request DELETE 'https://api.iswigo.com/v1/users/26f12881-9960-49b0-8d0c-2bb1530e703c' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
204 No Content Copy 
Empty response

Profile

GET Get profile

Get profile of authenticated user.

Copy 
https://api.iswigo.com/v1/profile

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Examples

Get profile
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/profile' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
    "email": "hector.berlioz@iswigo.com",
    "last_name": null,
    "first_name": null,
    "company": null,
    "terms_of_service": null,
    "last_terms_of_service": "2019-10-01"
}

PUT Update profile

Update profile of authenticated user.

Copy 
https://api.iswigo.com/v1/profile

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token
Content-Type *
application/json

Body

Copy 
{
	"email": "hector@berlioz.com",
    "terms_of_service": "2020-01-01"
}

Examples

Update profile
Request
Copy 
curl --location --request PUT 'https://api.iswigo.com/v1/profile' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "email": "hector@berlioz.com",
    "terms_of_service": "2020-01-01"
}'
Response
200 OK Copy 
{
    "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
    "email": "hector.berlioz@iswigo.com",
    "email_validation": "hector@berlioz.com",
    "last_name": null,
    "first_name": null,
    "company": null,
    "terms_of_service": "2020-01-01",
    "last_terms_of_service": "2019-10-01"
}

GET Get profile validation

Get status of profile validation and token if validation is in progress.

Information of token is available only for PSD2 compliant application.

Copy 
https://api.iswigo.com/v1/profile/validation

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Examples

Get profile validation (validated)
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/profile/validation' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "email": "hector@berlioz.com",
    "validated": true
}
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/profile/validation' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "email": "hector@berlioz.com",
    "validated": false,
    "token": "296430",
    "token_expiration": "2020-04-24T16:38:47+00:00"
}
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/profile/validation' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "email": null,
    "validated": false
}

POST Valid profile

Valid profile with a token.

Only for PSD2 compliant application.

Copy 
https://api.iswigo.com/v1/profile/validation

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token
Content-Type *
application/json

Body

Copy 
{
    "token": "980985"
}

Examples

Valid profile
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/profile/validation' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "token": "296430"
}'
Response
200 OK Copy 
true

Providers

GET Get providers

Get list of providers informations. Detailed form inputs and helps are available on the provider route.

Copy 
https://api.iswigo.com/v1/providers

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request

Query parameters

range
0-19
Range of results
filters[type]
document
Filter type of provider
filters[country]
FR
Filter providers by country
filters[scope]
2
Filter by scope (1: user, 2: delegate)

Examples

Get providers
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/providers' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}'
Response
200 OK Copy 
[
    {
        "provider_id": 1,
        "depend_of": 109,
        "name": "HSBC France - Particuliers",
        "logo": null,
        "url": null,
        "type": [
            "bank"
        ],
        "scope": 1,
        "status": "available",
        "properties": {
            "deferred_credit_card": true,
            "iban": true
        }
    },
    ...
]
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/providers?range=0-19&filters[type]=document' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}'
Response
200 OK Copy 
[
    ...
    {
        "provider_id": 4,
        "depend_of": 175,
        "name": "Crédit Agricole Atlantique Vendée",
        "logo": null,
        "url": null,
        "type": [
            "bank",
            "document"
        ],
        "scope": 1,
        "status": "available",
        "properties": {
            "deferred_credit_card": true,
            "iban": true,
            "docs": [
                "invoice",
                "document"
            ]
        }
    },
    ...
]

GET Get a provider

Get informations on a provider and associated authentication inputs.

Copy 
https://api.iswigo.com/v1/providers/:providerId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request

Path variables

providerId *
4
Provider ID

Examples

Get a provider
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/providers/4' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}'
Response
200 OK Copy 
{
    "provider_id": 4,
    "depend_of": 175,
    "name": "Crédit Agricole Atlantique Vendée",
    "logo": null,
    "url": null,
    "type": [
        "bank",
        "document"
    ],
    "scope": 1,
    "status": "available",
    "inputs": {
        "default": {
            "title": null,
            "inputs": [
                {
                    "name": "login",
                    "type": "text",
                    "varname": "login",
                    "maxlength": 11,
                    "label": "Numéro de compte (ou identifiant)"
                },
                {
                    "name": "password",
                    "type": "password",
                    "varname": "password",
                    "minlength": 6,
                    "maxlength": 6,
                    "mask": "numbers",
                    "label": "Code confidentiel (ou mot de passe)"
                }
            ]
        }
    },
    "help": {
        "admin": "Help for customer service."
    },
    "properties": {
        "deferred_credit_card": true,
        "iban": true,
        "docs": [
            "invoice",
            "document"
        ]
    }
}

GET Get status list of all providers

Get history status list of a provider.

Copy 
https://api.iswigo.com/v1/providers/status

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request

Query parameters

filters[status][]
available
Filter provider status by status

GET Get status list of a provider

Get history status list of a provider.

Copy 
https://api.iswigo.com/v1/providers/:providerId/status

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request

Query parameters

filters[status][]
available
Filter provider status by status

Path variables

providerId *
4
Provider ID

POST Suggest a provider

Suggest a new provider with login information of him.

Only for PSD2 compliant application.

Copy 
https://api.iswigo.com/v1/providers/suggestion

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token
Content-Type *
application/json

Body

Copy 
{
    "name": "My provider",
    "url": "https://iswigo.com/login",
    "login": "123456789",
    "password": "123456",
    "infos": null
}

Examples

Suggest a provider
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/providers/suggestion' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "name": "My provider",
    "url": "https://iswigo.com/login",
    "login": "123456789",
    "password": "123456",
    "infos": null
}'
Response
204 No Content Copy 
Empty response

Connections

POST Create a connection

Creates a provider connection with login information of him.

Only for PSD2 compliant application.

Copy 
https://api.iswigo.com/v1/connections

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token
Content-Type *
application/json

Body

Copy 
{
    "provider": 999,
    "login": "123456789",
    "password": "123456",
    "parameter3": null,
    "parameter4": null
}

Examples

Create a connection
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/connections' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "provider": 999,
    "login": "123456789",
    "password": "123456",
    "parameter3": null,
    "parameter4": null
}'
Response
201 Created Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "provider_id": 999,
    "create_time": "2020-04-24 15:36:48",
    "login": "123###789",
    "last_synchronized_time": null,
    "last_error_time": null,
    "nb_errors": 0,
    "automatic_synchronization": true
}

GET Get connections

Get provider connection list.

Copy 
https://api.iswigo.com/v1/connections

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Query parameters

range
0-19
Range of results
filters[type]
document
Filter type of connection

Examples

Get connections
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/connections' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
[
    {
        "connection_id": "2f26fc34-a432-47cb-9d67-e5cb0b8b86f9",
        "provider_id": 1005,
        "create_time": "2020-04-24 15:38:20",
        "login": "987####210",
        "last_synchronized_time": null,
        "last_error_time": "2020-04-24 15:38:45",
        "nb_errors": 1,
        "automatic_synchronization": true
    },
    {
        "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
        "provider_id": 999,
        "create_time": "2020-04-24 15:36:48",
        "login": "123###789",
        "last_synchronized_time": null,
        "last_error_time": null,
        "nb_errors": 0,
        "automatic_synchronization": false
    },
    {
        "connection_id": "9de67679-d433-432c-9560-8612377fc124",
        "provider_id": 1006,
        "create_time": "2020-04-24 15:58:20",
        "login": "hec############com",
        "last_synchronized_time": "2020-04-24 15:58:41",
        "last_error_time": null,
        "nb_errors": 0,
        "automatic_synchronization": true
    }
]
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/connections?filters[type]=document' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
[
    {
        "connection_id": "2f26fc34-a432-47cb-9d67-e5cb0b8b86f9",
        "provider_id": 1005,
        "create_time": "2020-04-24 15:38:20",
        "login": "987####210",
        "last_synchronized_time": null,
        "last_error_time": "2020-04-24 15:38:45",
        "nb_errors": 1,
        "automatic_synchronization": true
    },
    {
        "connection_id": "9de67679-d433-432c-9560-8612377fc124",
        "provider_id": 1006,
        "create_time": "2020-04-24 15:58:20",
        "login": "hec############com",
        "last_synchronized_time": "2020-04-24 15:58:41",
        "last_error_time": null,
        "nb_errors": 0,
        "automatic_synchronization": true
    }
]

GET Get a connection

Get a provider connection.

Copy 
https://api.iswigo.com/v1/connections/:connectionId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

connectionId *
82db2f8b-67ae-443f-b64a-44a2ac846f37
Connection ID

Examples

Get a connection
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "provider_id": 999,
    "create_time": "2020-04-24 15:36:48",
    "login": "123###789",
    "last_synchronized_time": null,
    "last_error_time": null,
    "nb_errors": 0,
    "automatic_synchronization": false
}

PUT Edit a connection

Edits a provider connection with login information of him.

Only for PSD2 compliant application.

Copy 
https://api.iswigo.com/v1/connections/:connectionId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token
Content-Type *
application/json

Path variables

connectionId *
82db2f8b-67ae-443f-b64a-44a2ac846f37
Connection ID

Body

Copy 
{
    "login": "123456789",
    "password": "123456",
    "parameter3": null,
    "parameter4": null
}

Examples

Edit a connection
Request
Copy 
curl --location --request PUT 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "login": "123456789",
    "password": "123456",
    "parameter3": null,
    "parameter4": null
}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "provider_id": 999,
    "create_time": "2020-04-24 15:36:48",
    "login": "123###789",
    "last_synchronized_time": null,
    "last_error_time": null,
    "nb_errors": 0,
    "automatic_synchronization": false
}

DELETE Delete a connection

Delete a provider connection.

Copy 
https://api.iswigo.com/v1/connections/:connectionId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

connectionId *
82db2f8b-67ae-443f-b64a-44a2ac846f37
Connection ID

Examples

Delete a connection
Request
Copy 
curl --location --request DELETE 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
204 No Content Copy 
Empty response

POST Synchronize a connection

Launch synchronization of a provider connection.

Copy 
https://api.iswigo.com/v1/connections/:connectionId/sync

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

connectionId *
82db2f8b-67ae-443f-b64a-44a2ac846f37
Connection ID

Examples

Synchronize a connection
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/sync' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "last_synchronized_time": "2020-04-24 16:37:26",
    "status": "pending",
    "step": null,
    "progression": null
}
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/sync' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "last_synchronized_time": "2020-04-24 16:37:26",
    "status": "in progress",
    "step": null,
    "progression": 40
}

POST Synchronize all connections

Launch synchronization of all providers connections.

Copy 
https://api.iswigo.com/v1/connections/sync

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Examples

Synchronize all connections
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/connections/sync' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
[
    {
        "connection_id": "2f26fc34-a432-47cb-9d67-e5cb0b8b86f9",
        "last_synchronized_time": null,
        "status": "pending",
        "step": null,
        "progression": null
    },
    {
        "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
        "last_synchronized_time": "2020-04-24 16:40:00",
        "status": "pending",
        "step": null,
        "progression": null
    },
    {
        "connection_id": "9de67679-d433-432c-9560-8612377fc124",
        "last_synchronized_time": "2020-04-24 15:58:41",
        "status": "pending",
        "step": null,
        "progression": null
    }
]

GET Status of connection

Get synchronization status of a connection.

Copy 
https://api.iswigo.com/v1/connections/:connectionId/status

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

connectionId *
82db2f8b-67ae-443f-b64a-44a2ac846f37
Connection ID

Examples

Status of connection (finished)
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/status' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "last_synchronized_time": "2020-04-24 16:37:26",
    "status": "finished",
    "status_code": 100,
    "status_reason": "OK",
    "step": null,
    "progression": null
}
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/status' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "last_synchronized_time": "2020-04-24 16:40:00",
    "status": "pending",
    "status_code": null,
    "status_reason": null,
    "step": null,
    "progression": null
}
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/status' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "last_synchronized_time": "2020-04-24 16:37:26",
    "status": "in progress",
    "status_code": null,
    "status_reason": null,
    "step": null,
    "progression": 40
}
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/status' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "last_synchronized_time": null,
    "status": "waiting user",
    "status_code": null,
    "status_reason": null,
    "step": "sms",
    "progression": null
}
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/status' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "last_synchronized_time": null,
    "status": "error",
    "status_code": 201,
    "status_reason": "Bad Credentials",
    "step": null,
    "progression": null
}

POST Step of connection

Unblock step for a synchronization in progress.

Only for PSD2 compliant application.

Copy 
https://api.iswigo.com/v1/connections/:connectionId/step

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token
Content-Type *
application/json

Path variables

connectionId *
82db2f8b-67ae-443f-b64a-44a2ac846f37
Connection ID

Body

Copy 
{
    "sms": "1234"
}

Examples

Step of connection (SMS)
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/step' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "sms": "1234"
}'
Response
200 OK Copy 
{
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "last_synchronized_time": null,
    "status": "pending",
    "step": null,
    "progression": null
}
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/step' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "sms": "1234"
}'
Response
400 Step not available Copy 
{
    "error": {
        "code": 400,
        "description": "Step not available"
    }
}

Bank

GET Get bank accounts

Get bank account list.

Copy 
https://api.iswigo.com/v1/bank/accounts

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Query parameters

range
0-19
Range of results
filters[connection][]
82db2f8b-67ae-443f-b64a-44a2ac846f37
Filter accounts by connection

Examples

Get bank accounts
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/accounts' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
[
    {
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
        "type": "account",
        "name": "Compte Chèque 123456789",
        "account_number": "00123456789",
        "bban": "111112222200123456789",
        "balance": 1000,
        "currency": "EUR",
        "is_professional": false,
        "parent_account_id": null,
        "last_time_found": "2020-04-24 16:10:24"
    },
    {
        "account_id": "08aae328-ed9f-4a05-961c-a5776aa4d0c3",
        "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
        "type": "deferred credit card",
        "name": "Carte Differe",
        "account_number": "xxxxxxxxxx785213",
        "bban": null,
        "balance": null,
        "currency": "EUR",
        "is_professional": false,
        "parent_account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "last_time_found": "2020-04-24 16:10:30"
    }
]

GET Get a bank account

Get a bank account.

Copy 
https://api.iswigo.com/v1/bank/accounts/:accountId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

accountId *
9d101ab3-5cf5-46a4-b94b-d5d2b5660503
Bank account ID

Examples

Get a bank account
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/accounts/9d101ab3-5cf5-46a4-b94b-d5d2b5660503' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
    "connection_id": "82db2f8b-67ae-443f-b64a-44a2ac846f37",
    "type": "account",
    "name": "Compte Chèque 123456789",
    "account_number": "00123456789",
    "bban": "111112222200123456789",
    "balance": 1000,
    "currency": "EUR",
    "is_professional": false,
    "parent_account_id": null,
    "last_time_found": "2020-04-24 16:10:24"
}

GET Get bank transactions

Get bank transactions list.

Copy 
https://api.iswigo.com/v1/bank/transactions

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Query parameters

range
0-19
Range of results
filters[start_date]
2020-01-01
Start date
filters[end_date]
2020-09-14
End date
filters[update_time]
2022-03-01 10:23:12
Update time greater than
filters[account][]
9d101ab3-5cf5-46a4-b94b-d5d2b5660503
Bank account ID
filters[connection][]
82db2f8b-67ae-443f-b64a-44a2ac846f37
Connection ID

Examples

Get bank transactions
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/transactions?filters[account][]=9d101ab3-5cf5-46a4-b94b-d5d2b5660503' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
[
    {
        "transaction_id": "99f28852-b1ea-4d60-89d8-38690cb06dea",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "76",
        "check_number": null,
        "amount": -12,
        "wording": "Cotisation",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "09488846-646a-48cc-b48d-dd962c7d30a0",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "28",
        "check_number": null,
        "amount": -20,
        "wording": "CARTE ESSENCE DAC",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "41e022df-0eb7-43f1-9304-cde088bcc096",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "01",
        "check_number": null,
        "amount": -50,
        "wording": "Cheque n9990001",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "d331109e-18e5-479a-a223-f8e2f57f3589",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "01",
        "check_number": null,
        "amount": -100,
        "wording": "Cheque n9990002",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "ea8512c9-dee7-4411-bd37-5e85dda08b6b",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "01",
        "check_number": null,
        "amount": 170,
        "wording": "cheque n 9990003",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "ea1a4d7b-2b6a-4a24-b9e6-16c687fb2274",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "01",
        "check_number": null,
        "amount": -200,
        "wording": "chèque n 9990004",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    }
]

GET Get a bank transaction

Get a bank transaction defined in url.

Copy 
https://api.iswigo.com/v1/bank/transactions/:transactionId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

transactionId *
41e022df-0eb7-43f1-9304-cde088bcc096
Bank transaction ID

Examples

Get a bank transaction
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/transactions/41e022df-0eb7-43f1-9304-cde088bcc096' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "transaction_id": "41e022df-0eb7-43f1-9304-cde088bcc096",
    "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
    "operation_date": "2020-04-24",
    "value_date": "2020-04-24",
    "accounting_date": null,
    "interbank_code": "01",
    "cc_order_month": null,
    "check_number": null,
    "amount": -50,
    "wording": "Cheque n9990001",
    "text": ".",
    "update_time": "2020-04-24 16:10:24",
    "is_deleted": false
}

GET Download bank transactions

Download bank transactions.

Copy 
https://api.iswigo.com/v1/bank/transactions/download

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Query parameters

filters[start_date]
2020-01-01
Start date
filters[end_date]
2020-09-14
End date
filters[account][]
9d101ab3-5cf5-46a4-b94b-d5d2b5660503
Bank account ID

Examples

Download bank transactions
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/transactions/download' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
0111111    22222EUR2 00123456789  240420                                                  00000000121200                
0411111    22222EUR2 0012345678991240420  240420Cotisation                                00000000001200                
0411111    22222EUR2 0012345678928240420  240420CARTE SUPER U ESSENCE DAC                 00000000002000                
0411111    22222EUR2 0012345678901240420  240420cheque n9990001                           00000000005000                
0411111    22222EUR2 0012345678901240420  240420cheque n9990002                           00000000010000                
0411111    22222EUR2 0012345678902240420  240420cheque n 9990003                          00000000017000                
0411111    22222EUR2 0012345678991240420  240420cheque n 9990004                          00000000020000                
0711111    22222EUR2 00123456789  240420                                                  00000000100000
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/transactions/download?filters[end_date]=2020-01-31' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
0111111    22222EUR2 00123456789  310120                                                  00000000100000                
0711111    22222EUR2 00123456789  310120                                                  00000000100000

GET Get bank account transactions (DEPRECATED)

Get bank transaction list of a bank account defined in url.

DEPRECATED: Use the "/v1/bank/transactions" route instead.

Copy 
https://api.iswigo.com/v1/bank/accounts/:accountId/transactions

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Query parameters

range
0-19
Range of results
filters[start_date]
2020-01-01
Start date
filters[end_date]
2020-09-14
End date
filters[update_time]
2022-03-01 10:23:12
Update time greater than

Path variables

accountId *
9d101ab3-5cf5-46a4-b94b-d5d2b5660503
Bank account ID

Examples

Get bank account transactions
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/accounts/9d101ab3-5cf5-46a4-b94b-d5d2b5660503/transactions' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
[
    {
        "transaction_id": "99f28852-b1ea-4d60-89d8-38690cb06dea",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "76",
        "check_number": null,
        "amount": -12,
        "wording": "Cotisation",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "09488846-646a-48cc-b48d-dd962c7d30a0",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "28",
        "check_number": null,
        "amount": -20,
        "wording": "CARTE ESSENCE DAC",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "41e022df-0eb7-43f1-9304-cde088bcc096",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "01",
        "check_number": null,
        "amount": -50,
        "wording": "Cheque n9990001",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "d331109e-18e5-479a-a223-f8e2f57f3589",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "01",
        "check_number": null,
        "amount": -100,
        "wording": "Cheque n9990002",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "ea8512c9-dee7-4411-bd37-5e85dda08b6b",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "01",
        "check_number": null,
        "amount": 170,
        "wording": "cheque n 9990003",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    },
    {
        "transaction_id": "ea1a4d7b-2b6a-4a24-b9e6-16c687fb2274",
        "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
        "operation_date": "2020-04-24",
        "value_date": "2020-04-24",
        "accounting_date": null,
        "cc_order_month": null,
        "interbank_code": "01",
        "check_number": null,
        "amount": -200,
        "wording": "chèque n 9990004",
        "text": ".",
        "update_time": "2020-04-24 16:10:24",
        "is_deleted": false
    }
]

GET Get a bank account transaction (DEPRECATED)

Get a bank transaction of a bank account defined in url.

DEPRECATED: Use the "/v1/bank/transactions/:transactionId" route instead.

Copy 
https://api.iswigo.com/v1/bank/accounts/:accountId/transactions/:transactionId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

accountId *
9d101ab3-5cf5-46a4-b94b-d5d2b5660503
Bank account ID
transactionId *
41e022df-0eb7-43f1-9304-cde088bcc096
Bank transaction ID

Examples

Get a bank account transaction
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/accounts/9d101ab3-5cf5-46a4-b94b-d5d2b5660503/transactions/41e022df-0eb7-43f1-9304-cde088bcc096' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "transaction_id": "41e022df-0eb7-43f1-9304-cde088bcc096",
    "account_id": "9d101ab3-5cf5-46a4-b94b-d5d2b5660503",
    "operation_date": "2020-04-24",
    "value_date": "2020-04-24",
    "accounting_date": null,
    "interbank_code": "01",
    "cc_order_month": null,
    "check_number": null,
    "amount": -50,
    "wording": "Cheque n9990001",
    "text": ".",
    "update_time": "2020-04-24 16:10:24",
    "is_deleted": false
}

GET Download a bank account (DEPRECATED)

Download a bank account.

DEPRECATED: Use the "/v1/bank/transactions/download" route instead.

Copy 
https://api.iswigo.com/v1/bank/accounts/:accountId/download

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Query parameters

filters[start_date]
2020-01-01
Start date
filters[end_date]
2020-09-14
End date

Path variables

accountId *
9d101ab3-5cf5-46a4-b94b-d5d2b5660503
Bank account ID

Examples

Download a bank account
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/accounts/9d101ab3-5cf5-46a4-b94b-d5d2b5660503/download' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
0111111    22222EUR2 00123456789  240420                                                  00000000121200                
0411111    22222EUR2 0012345678991240420  240420Cotisation                                00000000001200                
0411111    22222EUR2 0012345678928240420  240420CARTE SUPER U ESSENCE DAC                 00000000002000                
0411111    22222EUR2 0012345678901240420  240420cheque n9990001                           00000000005000                
0411111    22222EUR2 0012345678901240420  240420cheque n9990002                           00000000010000                
0411111    22222EUR2 0012345678902240420  240420cheque n 9990003                          00000000017000                
0411111    22222EUR2 0012345678991240420  240420cheque n 9990004                          00000000020000                
0711111    22222EUR2 00123456789  240420                                                  00000000100000
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/bank/accounts/6b9d461e-3fb9-4134-bffb-79cfa9abda34/download?filters[end_date]=2020-01-31' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
0111111    22222EUR2 00123456789  310120                                                  00000000100000                
0711111    22222EUR2 00123456789  310120                                                  00000000100000

Documents

GET Get document list

Get document list.

Additionnal meta data are available according the document type.

Copy 
https://api.iswigo.com/v1/documents

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Query parameters

range
0-19
Range of results
filters[connection][]
9de67679-d433-432c-9560-8612377fc124
Filter documents by connection
filters[update_time]
2022-03-01 10:23:12
Update time greater than
filters[type][]
invoice
Filter types of documents

Examples

Get documents
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/documents' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
[
    {
        "document_id": "e957d7d7-8688-4682-8433-c0c6cd7b555f",
        "connection_id": "9de67679-d433-432c-9560-8612377fc124",
        "create_time": "2020-04-24 15:58:41",
        "name": "Facture du 2020-05-04",
        "extension": "pdf",
        "mime": "application/pdf",
        "size": 72982,
        "type": "invoice",
        "meta": {
            "amount": {
                "total": 75000
            },
            "date": {
                "date": "2020-05-04"
            }
        },
        "hash": {
            "sha1": "72fa0e87f41edd01f733a99357cacab891cd4439"
        }
    },
    {
        "document_id": "3af19905-08cc-4742-b531-389465ae3554",
        "connection_id": "9de67679-d433-432c-9560-8612377fc124",
        "create_time": "2020-04-24 15:58:41",
        "name": "Document n°1587736721 du 2020-04-24",
        "extension": "pdf",
        "mime": "application/pdf",
        "size": 72982,
        "type": "document",
        "meta": [],
        "hash": {
            "sha1": "72fa0e87f41edd01f733a99357cacab891cd4439"
        }
    }
]

GET Get a document

Get document information.

Additionnal meta data are available according the document type.

Copy 
https://api.iswigo.com/v1/documents/:documentId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

documentId *
e957d7d7-8688-4682-8433-c0c6cd7b555f
Document ID

Examples

Get a document
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/documents/e957d7d7-8688-4682-8433-c0c6cd7b555f' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
200 OK Copy 
{
    "document_id": "e957d7d7-8688-4682-8433-c0c6cd7b555f",
    "connection_id": "9de67679-d433-432c-9560-8612377fc124",
    "create_time": "2020-04-24 15:58:41",
    "name": "Facture du 2020-05-04",
    "extension": "pdf",
    "mime": "application/pdf",
    "size": 72982,
    "type": "invoice",
    "meta": {
        "amount": {
            "total": 75000
        },
        "date": {
            "date": "2020-05-04"
        }
    },
    "hash": {
        "sha1": "72fa0e87f41edd01f733a99357cacab891cd4439"
    }
}

GET Download a document

Download a document.

Copy 
https://api.iswigo.com/v1/documents/:documentId/download

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

documentId *
e957d7d7-8688-4682-8433-c0c6cd7b555f
Document ID

Examples

Download a document
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/documents/e957d7d7-8688-4682-8433-c0c6cd7b555f/download' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
Copy 
Empty response

Funnel

POST Create a funnel session

Create a funnel session.

Copy 
https://api.iswigo.com/v1/funnel

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token
Content-Type *
application/json

Body

Copy 
{
    "action": "create",
    "type": "bank",
    "scope": null,
    "provider": null,
    "connections": [],
    "country": null,
    "redirect_uri": null
}

Examples

Create a funnel session
Request
Copy 
curl --location --request POST 'https://api.iswigo.com/v1/funnel' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
    --header 'Content-Type: application/json' \
    --data-raw '{
    "action": "create",
    "type": "bank",
    "connections": [],
    "country": null,
    "redirect_uri": null
}'
Response
201 Created Copy 
{
    "session_id": "e838e706-980f-4557-a9f3-04fd8b9a52cf",
    "uri": "https://widget.iswigo.com/?session=e838e706-980f-4557-a9f3-04fd8b9a52cf"
}

DELETE Delete a funnel session

Delete a funnel session with its identifier.

Copy 
https://api.iswigo.com/v1/funnel/:sessionId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request
Authorization *
Bearer {{ACCESS_TOKEN}}
User access token

Path variables

sessionId *
e838e706-980f-4557-a9f3-04fd8b9a52cf
Session ID

Examples

Delete a funnel session
Request
Copy 
curl --location --request DELETE 'https://api.iswigo.com/v1/funnel/e838e706-980f-4557-a9f3-04fd8b9a52cf' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}' \
    --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
Response
204 No Content Copy 
Empty response

Events

GET Get events

Get all events of all your users.

Copy 
https://api.iswigo.com/v1/events

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request

Query parameters

range
0-19
Range of results
filters[type][]
connection.status
Filter types of events
filters[create_time]
2022-03-01 10:23:12
Create time greater than

Examples

Get events
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/events' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}'
Response
200 OK Copy 
[
    {
        "event_id": "9135591a-302b-4935-b48d-dcd4ec55452a",
        "create_time": "2020-04-24T16:46:27+00:00",
        "type": "connection.status",
        "data": {
            "connection_id": "2f26fc34-a432-47cb-9d67-e5cb0b8b86f9",
            "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
            "status": "error",
            "step": null,
            "progression": null,
            "errno": "2"
        }
    },
    {
        "event_id": "f8798a05-b15d-4c60-883b-8772c0aec3b6",
        "create_time": "2020-04-24T16:46:27+00:00",
        "type": "connection.status",
        "data": {
            "connection_id": "9de67679-d433-432c-9560-8612377fc124",
            "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
            "status": "finished",
            "step": null,
            "progression": null
        }
    },
    ...
]

GET Get an event

Get an event.

Copy 
https://api.iswigo.com/v1/events/:eventId

Headers

X-Iswigo-App *
{{APP_NAME}}
Application identifier
X-Iswigo-Signature *
{{SIGNATURE}}
Signature of request

Path variables

eventId *
f8798a05-b15d-4c60-883b-8772c0aec3b6
Event ID

Examples

Get an event
Request
Copy 
curl --location --request GET 'https://api.iswigo.com/v1/events/f8798a05-b15d-4c60-883b-8772c0aec3b6' \
    --header 'X-Iswigo-App: {{APP_NAME}}' \
    --header 'X-Iswigo-Signature: {{SIGNATURE}}'
Response
200 OK Copy 
{
    "event_id": "f8798a05-b15d-4c60-883b-8772c0aec3b6",
    "create_time": "2020-04-24T16:46:27+00:00",
    "type": "connection.status",
    "data": {
        "connection_id": "9de67679-d433-432c-9560-8612377fc124",
        "user_id": "26f12881-9960-49b0-8d0c-2bb1530e703c",
        "status": "finished",
        "step": null,
        "progression": null
    }
}