SpareSpare Docs
GuidesAPI Reference

Beneficiaries & Parties

Beneficiaries, account parties, and direct debits.

GET
/api/v1.0/ais/Beneficiary/Get
Authorization
Query

Account id

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/Beneficiary/Get?accountId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "accountHolderName": "string",      "accountHolderShortName": "string",      "beneficiaryType": "string",      "reference": "string",      "creditorAccount": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "scheme": "string",          "identification": "string",          "name": "string"        }      ],      "creditorAgent": {        "name": "string",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "address": {          "addressType": "string",          "department": "string",          "subDepartment": "string",          "addressLine": "string",          "streetName": "string",          "buildingNumber": "string",          "postalCode": "string",          "townName": "string",          "countrySubDivision": "string",          "country": "string",          "shortAddress": "string",          "unitNumber": 0,          "secondaryNumber": "string",          "district": "string",          "city": "string"        },        "scheme": "string",        "identification": "string"      }    }  ]}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
GET
/api/v1.0/ais/DirectDebit/Get
Authorization
Query

Account id

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/DirectDebit/Get?accountId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "mandateIdentification": "string",      "directDebitStatusCode": "string",      "name": "string",      "frequency": "string",      "previousPaymentDateTime": "2019-08-24T14:15:22Z",      "previousPaymentAmount": "string",      "previousPaymentCurrency": "string"    }  ]}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty
GET
/api/v1.0/ais/Parties/Get
Authorization
Query

Account id

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1.0/ais/Parties/Get?accountId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "partyNumber": "string",      "partyType": "string",      "accountRole": "string",      "verifiedClaims": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z",          "verification": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z",            "assuranceProcess": {              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",              "createdAt": "2019-08-24T14:15:22Z",              "updatedAt": "2019-08-24T14:15:22Z",              "assuranceDetails": [                {                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",                  "createdAt": "2019-08-24T14:15:22Z",                  "updatedAt": "2019-08-24T14:15:22Z",                  "evidenceReference": [                    {                      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",                      "createdAt": "2019-08-24T14:15:22Z",                      "updatedAt": "2019-08-24T14:15:22Z",                      "evidenceClassification": "string",                      "txn": "string"                    }                  ],                  "evidenceRef": [                    {                      "evidenceClassification": "string",                      "txn": "string"                    }                  ],                  "assuranceClassification": "string",                  "assuranceType": "string"                }              ],              "policy": "string",              "procedure": "string"            },            "evidence": [              {                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",                "createdAt": "2019-08-24T14:15:22Z",                "updatedAt": "2019-08-24T14:15:22Z",                "documentDetails": {                  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",                  "createdAt": "2019-08-24T14:15:22Z",                  "updatedAt": "2019-08-24T14:15:22Z",                  "type": "string",                  "documentNumber": "string",                  "personalNumber": "string",                  "serialNumber": "string",                  "calendarType": "string",                  "dateOfIssuance": "2019-08-24T14:15:22Z",                  "dateOfExpiry": "2019-08-24T14:15:22Z",                  "issuerName": "string",                  "issuerAddress": "string",                  "issuerStreetAddress": "string",                  "issuerLocality": "string",                  "issuerRegion": "string",                  "issuerPostalCode": "string",                  "issuerCountry": "string",                  "issuerCountryCode": "string",                  "issuerJurisdiction": "string"                },                "type": "string",                "verifierOrganization": "string",                "verifierTxn": "string",                "time": "2019-08-24T14:15:22Z",                "attachments": [                  {                    "description": "string",                    "contentType": "string",                    "content": "string",                    "identifier": "string"                  }                ],                "details": [                  {                    "checkMethod": "string",                    "organization": "string",                    "time": "2019-08-24T14:15:22Z",                    "identifier": "string"                  }                ]              }            ],            "assuranceLevel": "string",            "time": "2019-08-24T14:15:22Z",            "trustFramework": "string",            "verificationProcess": "string"          },          "claims": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z",            "countryAddress": "string",            "formattedAddress": "string",            "localityAddress": "string",            "regionAddress": "string",            "streetAddress": "string",            "alsoKnownAs": "string",            "birthDate": "2019-08-24T14:15:22Z",            "birthFamilyName": "string",            "birthGivenName": "string",            "birthMiddleName": "string",            "email": "string",            "emailVerified": true,            "familyName": "string",            "gender": "string",            "givenName": "string",            "locale": "string",            "middleName": "string",            "msisdn": "string",            "name": "string",            "nationalities": [              "string"            ],            "nickname": "string",            "phoneNumber": "string",            "phoneNumberVerified": true,            "picture": "string",            "countryPlaceOfBirth": "string",            "localityPlaceOfBirth": "string",            "regionPlaceOfBirth": "string",            "preferredUsername": "string",            "profile": "string",            "salutation": "string",            "subject": "string",            "title": "string",            "website": "string",            "zoneInfo": "string"          }        }      ]    }  ]}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
{  "error": "INVALID_DATA",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "data": null}
Empty