Spare

Spare Parties API

The Parties API from Spare — 1 operation(s) for parties.

GitHub OpenAPI

Operations 1

GET /api/v1.0/ais/Parties/Get Get account parties

Documentation

📖
Documentation
https://docs.tryspare.com/docs/auth-flow
📖
APIReference
https://docs.tryspare.com/reference/get_api-v1-0-authentication-token
📖
Documentation
https://docs.tryspare.com/docs/data-api-basics
📖
APIReference
https://docs.tryspare.com/reference/get_api-v1-0-ais-account-list-1
📖
Documentation
https://docs.tryspare.com/docs/payments-api-basics
📖
APIReference
https://docs.tryspare.com/reference/create-business-domestic-payment
📖
Documentation
https://docs.tryspare.com/docs/ksa-coverage

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/spare/refs/heads/main/openapi/spare-parties-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/spare-parties-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

spare-parties-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Information Account Parties API
  description: Spare account information API documentation
  termsOfService: https://terms.tryspare.com/en
  contact:
    name: Spare Technologies WLL.
    email: hello@tryspare.com
  license:
    name: Spare Technologies WLL.
  version: '1.0'
servers:
- url: https://ob.tryspare.com/api/v1.0/authentication
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- Bearer: []
tags:
- name: Parties
paths:
  /api/v1.0/ais/Parties/Get:
    get:
      tags:
      - Parties
      summary: Get account parties
      description: "**Unique resource name :** ais.v1.parties.get\n            \n**Important!:**\n            \nThe permissions bellow are required on the consent:\n- `ReadParty`"
      parameters:
      - name: accountId
        in: query
        description: Account id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '500':
          description: Internal Server Error
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartiesResponseModelIEnumerableApiResponse'
        '400':
          description: '- If account id is not valid'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
        '404':
          description: '- If account does not exists'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectApiResponse'
components:
  schemas:
    ObjectApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
        data: {}
      additionalProperties: false
    PartiesResponseModelIEnumerableApiResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        errorDescription:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: string
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PartiesResponseModel'
      additionalProperties: false
    EvidenceResponseModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        documentDetails:
          $ref: '#/components/schemas/DocumentDetailsResponseModel'
        type:
          type:
          - string
          - 'null'
        verifierOrganization:
          type:
          - string
          - 'null'
        verifierTxn:
          type:
          - string
          - 'null'
        time:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    AssuranceDetailResponseModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        evidenceReference:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EvidenceReferenceResponseModel'
        evidenceRef:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EvidenceReferenceModel'
        assuranceClassification:
          type:
          - string
          - 'null'
        assuranceType:
          type:
          - string
          - 'null'
      additionalProperties: false
    DocumentDetailsResponseModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        type:
          type:
          - string
          - 'null'
        documentNumber:
          type:
          - string
          - 'null'
        personalNumber:
          type:
          - string
          - 'null'
        serialNumber:
          type:
          - string
          - 'null'
        calendarType:
          type:
          - string
          - 'null'
        dateOfIssuance:
          type:
          - string
          - 'null'
          format: date-time
        dateOfExpiry:
          type:
          - string
          - 'null'
          format: date-time
        issuerName:
          type:
          - string
          - 'null'
        issuerAddress:
          type:
          - string
          - 'null'
        issuerStreetAddress:
          type:
          - string
          - 'null'
        issuerLocality:
          type:
          - string
          - 'null'
        issuerRegion:
          type:
          - string
          - 'null'
        issuerPostalCode:
          type:
          - string
          - 'null'
        issuerCountry:
          type:
          - string
          - 'null'
        issuerCountryCode:
          type:
          - string
          - 'null'
        issuerJurisdiction:
          type:
          - string
          - 'null'
      additionalProperties: false
    VerifiedClaimsResponseModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        verification:
          $ref: '#/components/schemas/VerificationResponseModel'
        claims:
          $ref: '#/components/schemas/ClaimsResponseModel'
      additionalProperties: false
    PartiesResponseModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        accountId:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        partyNumber:
          type:
          - string
          - 'null'
        partyType:
          type:
          - string
          - 'null'
        accountRole:
          type:
          - string
          - 'null'
        verifiedClaims:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VerifiedClaimsResponseModel'
      additionalProperties: false
    EvidenceReferenceResponseModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        evidenceClassification:
          type:
          - string
          - 'null'
        txn:
          type:
          - string
          - 'null'
      additionalProperties: false
    ApiError:
      enum:
      - INVALID_DATA
      - INVALID_SIGNATURE
      - RESOURCE_LOCKED
      - COUNTRY_NOT_FOUND
      - CURRENCY_NOT_FOUND
      - PROVIDER_NOT_FOUND
      - CONNECTION_NOT_FOUND
      - INSUFFICIENT_CONSENT_PERMISSIONS
      - CONSENT_EXPIRED
      - CONSENT_REVOKED
      - CONSENT_UNAUTHORIZED
      - CONSENT_NOT_FOUND
      - RISK_REPORT_NOT_FOUND
      - ACCOUNT_INFORMATION_REPORT_NOT_FOUND
      - MULTIPLE_CURRENCY_NOT_ALLOWED
      - MULTIPLE_CONSENT_DATE_NOT_ALLOWED
      - PAYMENT_NOT_FOUND
      - CONSENT_REJECTED
      - PAYMENT_REQUEST_NOT_FOUND
      - CUSTOMER_NOT_FOUND
      - CUSTOMER_ALREADY_EXISTS
      - BANK_ACCOUNT_NOT_FOUND
      - SERVER_ERROR
      - PROVIDER_CONNECTION_FAILURE
      - TRANSACTION_NOT_FOUND
      - ACCOUNT_INFORMATION_ACCESS_REQUEST_NOT_FOUND
      - CONSENT_REVOCATION_FAILED
      - CONSENT_REVOKED_OR_EXPIRED
      - SUBSCRIPTION_EXPIRED
      - NOT_SUBSCRIBED_TO_SERVICE
      - BENEFICIARY_NOT_FOUND
      - PARTIES_NOT_FOUND
      - DIRECT_DEBIT_NOT_FOUND
      - SCHEDULED_PAYMENT_NOT_FOUND
      - DEBTOR_ACCOUNT_NOT_FOUND
      - CREDITOR_ACCOUNT_NOT_FOUND
      - UNAUTHORIZED_IP_ADDRESS
      type: string
    ClaimsResponseModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        countryAddress:
          type:
          - string
          - 'null'
        formattedAddress:
          type:
          - string
          - 'null'
        localityAddress:
          type:
          - string
          - 'null'
        regionAddress:
          type:
          - string
          - 'null'
        streetAddress:
          type:
          - string
          - 'null'
        alsoKnownAs:
          type:
          - string
          - 'null'
        birthDate:
          type:
          - string
          - 'null'
          format: date-time
        birthFamilyName:
          type:
          - string
          - 'null'
        birthGivenName:
          type:
          - string
          - 'null'
        birthMiddleName:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        emailVerified:
          type:
          - boolean
          - 'null'
        familyName:
          type:
          - string
          - 'null'
        gender:
          type:
          - string
          - 'null'
        givenName:
          type:
          - string
          - 'null'
        locale:
          type:
          - string
          - 'null'
        middleName:
          type:
          - string
          - 'null'
        msisdn:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        nationalities:
          type:
          - array
          - 'null'
          items:
            type: string
        nickname:
          type:
          - string
          - 'null'
        phoneNumber:
          type:
          - string
          - 'null'
        phoneNumberVerified:
          type:
          - boolean
          - 'null'
        picture:
          type:
          - string
          - 'null'
        countryPlaceOfBirth:
          type:
          - string
          - 'null'
        localityPlaceOfBirth:
          type:
          - string
          - 'null'
        regionPlaceOfBirth:
          type:
          - string
          - 'null'
        preferredUsername:
          type:
          - string
          - 'null'
        profile:
          type:
          - string
          - 'null'
        salutation:
          type:
          - string
          - 'null'
        subject:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        website:
          type:
          - string
          - 'null'
        zoneInfo:
          type:
          - string
          - 'null'
      additionalProperties: false
    VerificationResponseModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        assuranceProcess:
          $ref: '#/components/schemas/AssuranceProcessResponseModel'
        evidence:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EvidenceResponseModel'
        assuranceLevel:
          type:
          - string
          - 'null'
        time:
          type:
          - string
          - 'null'
          format: date-time
        trustFramework:
          type:
          - string
          - 'null'
        verificationProcess:
          type:
          - string
          - 'null'
      additionalProperties: false
    AssuranceProcessResponseModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        createdAt:
          type:
          - string
          - 'null'
          format: date-time
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
        assuranceDetails:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssuranceDetailResponseModel'
        policy:
          type:
          - string
          - 'null'
        procedure:
          type:
          - string
          - 'null'
      additionalProperties: false
    EvidenceReferenceModel:
      type: object
      properties:
        evidenceClassification:
          type:
          - string
          - 'null'
        txn:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please enter into field the word 'Bearer' followed by a space and JWT
      name: Authorization
      in: header