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.

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

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

Examples

Create new user
Request
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
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).

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

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

Examples

Successful authentication
Request
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
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.

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
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.

https://api.iswigo.com/v1/users/26f12881-9960-49b0-8d0c-2bb1530e703c

Headers

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

Examples

Get a user
Request
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.

https://api.iswigo.com/v1/users/26f12881-9960-49b0-8d0c-2bb1530e703c/email

Headers

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

Body

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

Examples

Edit a user email
Request
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
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.

https://api.iswigo.com/v1/users/26f12881-9960-49b0-8d0c-2bb1530e703c/password

Headers

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

Body

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

Examples

Try to edit user password with bad current password
Request
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"
    }
}
Request
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
}

DELETE Delete a user

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

Irreversible action! We cannot restore deleted accounts.

https://api.iswigo.com/v1/users/2a80c5df-c72f-4324-99e2-e476f7e736b4

Headers

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

Examples

Delete a user
Request
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.

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
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.

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

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

Examples

Update profile
Request
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.

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 (empty)
Request
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
}
Request
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
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"
}

POST Valid profile

Valid profile with a token.

Only for PSD2 compliant application.

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

{
    "token": "980985"
}

Examples

Valid profile
Request
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 and associated authentication inputs.

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

Examples

Get providers
Request
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"
        ],
        "status": "available",
        "inputs": {
            "default": {
                "title": null,
                "inputs": [
                    {
                        "name": "login",
                        "type": "text",
                        "varname": "login",
                        "minlength": 11,
                        "maxlength": 11,
                        "label": "Numéro de compte (ou identifiant)"
                    },
                    {
                        "name": "memorable",
                        "type": "password",
                        "varname": "parameter3",
                        "minlength": 6,
                        "maxlength": 50,
                        "label": "Réponse à question mémorable"
                    },
                    {
                        "name": "password",
                        "type": "password",
                        "varname": "password",
                        "label": "Code confidentiel (ou mot de passe)"
                    }
                ]
            },
            "securekey": {
                "title": "Générez un code à usage unique \"SecureKey\" pour votre banque <strong>%b%</strong> <em>(identifiant <strong>%i%</strong>)</em> et entrez le",
                "inputs": [
                    {
                        "name": "securekey",
                        "type": "text",
                        "varname": "securekey",
                        "minlength": 6,
                        "maxlength": 6,
                        "label": "Code à usage unique \"SecureKey\""
                    }
                ]
            }
        },
        "properties": {
            "deferred_credit_card": true,
            "iban": true
        }
    },
    ...
]
Request
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"
        ],
        "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)"
                    }
                ]
            }
        },
        "properties": {
            "deferred_credit_card": true,
            "iban": true,
            "docs": [
                "invoice",
                "document"
            ]
        }
    },
    ...
]

GET Get a provider

Get informations on a provider and associated authentication inputs.

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

Headers

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

Examples

Get a provider
Request
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"
    ],
    "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)"
                }
            ]
        }
    },
    "properties": {
        "deferred_credit_card": true,
        "iban": true,
        "docs": [
            "invoice",
            "document"
        ]
    }
}

Connections

POST Create a connection

Creates a provider connection with login information of him.

Only for PSD2 compliant application.

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

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

Examples

Create a connection
Request
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.

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 filtered connections
Request
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
    }
]
Request
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
    }
]

GET Get a connection

Get a provider connection.

https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37

Headers

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

Examples

Get a connection
Request
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.

https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37

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

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

Examples

Edit a connection
Request
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.

https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37

Headers

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

Examples

Delete a connection
Request
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.

https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/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 a connection
Request
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
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.

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
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.

https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/status

Headers

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

Examples

Status of connection (finished)
Request
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",
    "step": null,
    "progression": null
}
Request
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",
    "step": null,
    "progression": null
}
Request
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",
    "step": null,
    "progression": 40
}
Request
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",
    "step": "sms",
    "progression": null
}
Request
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",
    "step": null,
    "progression": null,
    "errno": 200
}

POST Step of connection

Unblock step for a synchronization in progress.

Only for PSD2 compliant application.

https://api.iswigo.com/v1/connections/82db2f8b-67ae-443f-b64a-44a2ac846f37/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

Body

{
    "sms": "1234"
}

Examples

Step of connection out of context
Request
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"
    }
}
Request
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
}

Bank

GET Get bank accounts

Get bank account list.

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

Examples

Get bank accounts
Request
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
    },
    {
        "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"
    }
]

GET Get a bank account

Get a bank account.

https://api.iswigo.com/v1/bank/accounts/9d101ab3-5cf5-46a4-b94b-d5d2b5660503

Headers

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

Examples

Get a bank account
Request
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
}

GET Get bank account transactions

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

https://api.iswigo.com/v1/bank/accounts/9d101ab3-5cf5-46a4-b94b-d5d2b5660503/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

Examples

Get bank account transactions
Request
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,
        "check_number": null,
        "amount": -12,
        "wording": "Cotisation",
        "text": "."
    },
    {
        "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,
        "check_number": null,
        "amount": -20,
        "wording": "CARTE ESSENCE DAC",
        "text": "."
    },
    {
        "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,
        "check_number": null,
        "amount": -50,
        "wording": "Cheque n9990001",
        "text": "."
    },
    {
        "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,
        "check_number": null,
        "amount": -100,
        "wording": "Cheque n9990002",
        "text": "."
    },
    {
        "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,
        "check_number": null,
        "amount": 170,
        "wording": "cheque n 9990003",
        "text": "."
    },
    {
        "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,
        "check_number": null,
        "amount": -200,
        "wording": "chèque n 9990004",
        "text": "."
    }
]

GET Get a bank account transaction

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

https://api.iswigo.com/v1/bank/accounts/9d101ab3-5cf5-46a4-b94b-d5d2b5660503/transactions/41e022df-0eb7-43f1-9304-cde088bcc096

Headers

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

Examples

Get a bank account transaction
Request
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,
    "cc_order_month": null,
    "check_number": null,
    "amount": -50,
    "wording": "Cheque n9990001",
    "text": "."
}

Documents

GET Get document list

Get document list.

Additionnal meta data are available according the document type.

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[type]
invoice
Filter type of document

Examples

Get documents
Request
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": 750,
            "payment_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.

https://api.iswigo.com/v1/documents/e957d7d7-8688-4682-8433-c0c6cd7b555f

Headers

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

Examples

Get a document
Request
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": 750,
        "payment_date": "2020-05-04"
    },
    "hash": {
        "sha1": "72fa0e87f41edd01f733a99357cacab891cd4439"
    }
}

GET Download a document

Download a document.

https://api.iswigo.com/v1/documents/e957d7d7-8688-4682-8433-c0c6cd7b555f/download

Headers

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

Examples

Download a document
Request
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
Empty response

Funnel

POST Create a funnel session

Create a funnel session.

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

{
    "action": "create bank",
    "connections": []
}

Examples

Create a funnel session
Request
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 bank",
    "connections": []
}'
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.

https://api.iswigo.com/v1/funnel/e838e706-980f-4557-a9f3-04fd8b9a52cf

Headers

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

Examples

Delete a funnel session
Request
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.

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

Examples

Get events
Request
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.

https://api.iswigo.com/v1/events/f8798a05-b15d-4c60-883b-8772c0aec3b6

Headers

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

Examples

Get an event
Request
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
    }
}