---
updatedAt: 2025-09-16T20:47:50.000Z
agentTools:
  projectIndex: https://docs.tapico.io/llms.txt
---

# Retrieve a specific account group

Get details for a specific account group.

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "contact": {
      "email": "support@tapico.io",
      "name": "Tapico",
      "url": "http://www.tapico.io"
    },
    "description": "PLACEHOLDER DESCRIPTION",
    "termsOfService": "https://tapico.io/sandbox-tos/",
    "title": "Tapico API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "description": "Sandbox environment",
      "url": "https://api.sandbox.tapico.io/v1"
    },
    {
      "description": "Production environment",
      "url": "https://api.prod.tapico.io/v1"
    }
  ],
  "paths": {
    "/authorising-users/{authorisingUserId}/account-groups/{accountGroupId}": {
      "get": {
        "description": "Get details for a specific account group.\n",
        "parameters": [
          {
            "description": "Specifies the Region for the request. \nWhen specified, this must match the region that the application access token was generated for. \n\nFor more information about regions see https://docs.tapico.io/docs/regions\n",
            "example": "EU",
            "in": "header",
            "name": "region",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          },
          {
            "description": "Authorising User ID.",
            "in": "path",
            "name": "authorisingUserId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          },
          {
            "description": "Account Group ID.",
            "in": "path",
            "name": "accountGroupId",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountGroupsSuccess"
                }
              }
            },
            "description": "success response."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "The credentials used are not recognised."
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Forbidden."
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Entity cannot be found."
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Too many requests sent in quick succession."
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            },
            "description": "Internal Server Error."
          }
        },
        "security": [
          {
            "bearer": []
          }
        ],
        "summary": "Retrieve a specific account group",
        "tags": [
          "Account Groups"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Region": {
        "description": "Specifies the Region of the Account Servicer, hence the Region where the data associated to that Account Servicer is stored.",
        "enum": [
          "EU",
          "Pacific",
          "Asia",
          "US",
          "CA"
        ],
        "type": "string"
      },
      "ErrorResponse": {
        "properties": {
          "code": {
            "type": "string"
          },
          "correlationId": {
            "example": "cfadcc06-d059-4a1c-a5c2-b9d102c40294",
            "format": "uuid",
            "type": "string"
          },
          "errors": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "code",
          "correlationId",
          "errors"
        ],
        "type": "object"
      },
      "CustomerType": {
        "enum": [
          "NotSpecified",
          "Individual",
          "Organisation"
        ],
        "type": "string"
      },
      "AccountGroupsSuccess": {
        "example": {
          "data": [
            {
              "id": "80eafac6-33db-478a-bcc6-adda00c9bf93",
              "externalId": "001-0000000001",
              "secondaryExternalId": "XYZ000001",
              "accountName": "John Smith - Invididual",
              "accountServicer": {
                "id": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                "name": "Financial Platform A",
                "isActive": true,
                "hasAppStore": false,
                "defaultExpiryDays": 90,
                "hasPaymentsInitiation": true,
                "logoUri": "https://cdn.sandbox.tapico.io/images/logos/logo.png"
              },
              "servicingAgent": {
                "id": "a19811e2-4dbc-40ff-9afb-279c945217ae",
                "externalId": "002-0000051754",
                "secondaryExternalId": "EI006690000001",
                "name": "Irene Adler",
                "status": "Active",
                "address": {
                  "addressLines": [
                    "221b Baker St",
                    "London"
                  ],
                  "postCode": "NW1 6XE",
                  "countryCode": "GBR"
                },
                "servicingOrganisation": "039f9547-51c5-4768-89a1-79f145ef5174",
                "nationalCompetentAuthority": "FCA_GBR",
                "nationalCompetentAuthorityCode": "123456",
                "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                "lastChangeDetectedDateTime": "2019-11-25T09:12:28.000Z"
              },
              "type": "Individual",
              "accounts": [
                {
                  "id": "18c68ff9-02af-4133-9166-454918ca63cc",
                  "externalId": "000-0000000001",
                  "secondaryExternalId": "XYZ000001-001",
                  "accountName": "John Smith - Stocks and Shares ISA",
                  "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                  "baseCurrency": "GBP",
                  "businessOrPersonal": "Personal",
                  "sourceType": "GIA",
                  "subtype": "InvestmentAccount",
                  "type": "Investment",
                  "openingDate": "2010-01-01T00:00:00.000Z",
                  "updatedDateTime": "2019-11-20T09:12:28.000Z",
                  "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
                  "accountGroup": "80eafac6-33db-478a-bcc6-adda00c9bf93",
                  "agentIdentifiers": [
                    {
                      "identifier": 300053,
                      "identifierType": "SortCode"
                    }
                  ],
                  "identifiers": [
                    {
                      "identifier": 12345678,
                      "identifierType": "AccountNumber"
                    }
                  ],
                  "servicingAgent": "a19811e2-4dbc-40ff-9afb-279c945217ae"
                }
              ],
              "externalAccounts": [
                {
                  "id": "12b6452c-85bd-4237-8938-1f95a1521bcb",
                  "externalId": "157065",
                  "accountName": "John Smith - Current Account",
                  "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                  "servicingAgent": "a19811e2-4dbc-40ff-9afb-279c945217ae",
                  "accountGroup": "80eafac6-33db-478a-bcc6-adda00c9bf93",
                  "baseCurrency": "GBP",
                  "status": "Active",
                  "verificationStatus": "Passed",
                  "updatedDateTime": "2019-11-20T09:12:28.000Z",
                  "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
                  "agentIdentifiers": [
                    {
                      "identifier": 200042,
                      "identifierType": "SortCode"
                    }
                  ],
                  "identifiers": [
                    {
                      "identifier": 87654321,
                      "identifierType": "AccountNumber"
                    }
                  ]
                }
              ],
              "openingDate": "2010-01-01T00:00:00.000Z",
              "updatedDateTime": "2019-11-20T09:12:28.000Z",
              "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
              "roles": [
                {
                  "id": "5ad6553a-1de4-40fc-af88-43e438019c6a",
                  "updatedDateTime": "2021-01-01T01:01:01.000Z",
                  "roleType": "Individual",
                  "roleTypes": [
                    "Individual"
                  ],
                  "accountGroupId": "80eafac6-33db-478a-bcc6-adda00c9bf93",
                  "customer": {
                    "id": "92b74392-1c5f-4660-8d0e-78963df8b9fe",
                    "type": "Individual",
                    "givenName": "Motoko",
                    "familyName": "Kusanagi",
                    "dateOfBirth": "2004-01-20T00:00:00.000Z",
                    "externalId": "015-0000358748",
                    "secondaryExternalId": "358748",
                    "updatedDateTime": "2019-12-01T14:57:59.000Z",
                    "lastChangeDetectedDateTime": "2019-11-01T09:12:28.000Z",
                    "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                    "emails": [
                      {
                        "email": "motoko.kusanagi@tapico.io",
                        "type": "Personal"
                      }
                    ],
                    "phoneNumbers": [
                      {
                        "number": 447777777777,
                        "type": "Personal"
                      },
                      {
                        "number": 447777777777,
                        "type": "Home"
                      }
                    ]
                  }
                }
              ]
            },
            {
              "id": "80eafac6-33db-478a-bcc6-adda00c9bf93",
              "externalId": "001-0000000001",
              "secondaryExternalId": "XYZ000001",
              "accountName": "John Smith - Invididual",
              "accountServicer": {
                "id": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                "name": "Financial Platform A",
                "isActive": true,
                "hasAppStore": false,
                "defaultExpiryDays": 90,
                "hasPaymentsInitiation": true,
                "logoUri": "https://cdn.sandbox.tapico.io/images/logos/logo.png"
              },
              "servicingAgent": {
                "id": "a19811e2-4dbc-40ff-9afb-279c945217ae",
                "externalId": "002-0000051754",
                "secondaryExternalId": "EI006690000001",
                "name": "Irene Adler",
                "status": "Active",
                "address": {
                  "addressLines": [
                    "221b Baker St",
                    "London"
                  ],
                  "postCode": "NW1 6XE",
                  "countryCode": "GBR"
                },
                "servicingOrganisation": "039f9547-51c5-4768-89a1-79f145ef5174",
                "nationalCompetentAuthority": "FCA_GBR",
                "nationalCompetentAuthorityCode": "123456",
                "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                "lastChangeDetectedDateTime": "2019-11-25T09:12:28.000Z"
              },
              "type": "Individual",
              "accounts": [
                {
                  "id": "18c68ff9-02af-4133-9166-454918ca63cc",
                  "externalId": "000-0000000001",
                  "secondaryExternalId": "XYZ000001-001",
                  "accountName": "John Smith - Stocks and Shares ISA",
                  "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                  "baseCurrency": "GBP",
                  "businessOrPersonal": "Personal",
                  "sourceType": "GIA",
                  "subtype": "InvestmentAccount",
                  "type": "Investment",
                  "openingDate": "2010-01-01T00:00:00.000Z",
                  "updatedDateTime": "2019-11-20T09:12:28.000Z",
                  "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
                  "accountGroup": "80eafac6-33db-478a-bcc6-adda00c9bf93",
                  "agentIdentifiers": [
                    {
                      "identifier": 300053,
                      "identifierType": "SortCode"
                    }
                  ],
                  "identifiers": [
                    {
                      "identifier": 12345678,
                      "identifierType": "AccountNumber"
                    }
                  ],
                  "servicingAgent": "a19811e2-4dbc-40ff-9afb-279c945217ae"
                }
              ],
              "externalAccounts": [
                {
                  "id": "12b6452c-85bd-4237-8938-1f95a1521bcb",
                  "externalId": "157065",
                  "accountName": "John Smith - Current Account",
                  "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                  "servicingAgent": "a19811e2-4dbc-40ff-9afb-279c945217ae",
                  "accountGroup": "80eafac6-33db-478a-bcc6-adda00c9bf93",
                  "baseCurrency": "GBP",
                  "status": "Active",
                  "verificationStatus": "Passed",
                  "updatedDateTime": "2019-11-20T09:12:28.000Z",
                  "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
                  "agentIdentifiers": [
                    {
                      "identifier": 200042,
                      "identifierType": "SortCode"
                    }
                  ],
                  "identifiers": [
                    {
                      "identifier": 87654321,
                      "identifierType": "AccountNumber"
                    }
                  ]
                }
              ],
              "openingDate": "2010-01-01T00:00:00.000Z",
              "updatedDateTime": "2019-11-20T09:12:28.000Z",
              "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
              "roles": [
                {
                  "id": "5ad6553a-1de4-40fc-af88-43e438019c6a",
                  "updatedDateTime": "2021-01-01T01:01:01.000Z",
                  "roleType": "Individual",
                  "roleTypes": [
                    "Individual"
                  ],
                  "accountGroupId": "80eafac6-33db-478a-bcc6-adda00c9bf93",
                  "customer": {
                    "id": "92b74392-1c5f-4660-8d0e-78963df8b9fe",
                    "type": "Individual",
                    "givenName": "Motoko",
                    "familyName": "Kusanagi",
                    "dateOfBirth": "2004-01-20T00:00:00.000Z",
                    "externalId": "015-0000358748",
                    "secondaryExternalId": "358748",
                    "updatedDateTime": "2019-12-01T14:57:59.000Z",
                    "lastChangeDetectedDateTime": "2019-11-01T09:12:28.000Z",
                    "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                    "emails": [
                      {
                        "email": "motoko.kusanagi@tapico.io",
                        "type": "Personal"
                      }
                    ],
                    "phoneNumbers": [
                      {
                        "number": 447777777777,
                        "type": "Personal"
                      },
                      {
                        "number": 447777777777,
                        "type": "Home"
                      }
                    ]
                  }
                }
              ]
            }
          ],
          "meta": {
            "nextCursor": "Cn8KGwoEbmFtZRITGhFBbGxpZWQgSXJpc2ggQm",
            "correlationId": "cfadcc06-d059-4a1c-a5c2-b9d102c40294"
          }
        },
        "properties": {
          "meta": {
            "$ref": "#/components/schemas/Metadata"
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/AccountGroupWithRelations"
            },
            "type": "array"
          }
        },
        "required": [
          "data",
          "meta"
        ],
        "type": "object"
      },
      "Metadata": {
        "example": {
          "nextCursor": "Cn8KGwoEbmFtZRITGhFBbGxpZWQgSXJpc2ggQm",
          "correlationId": "cfadcc06-d059-4a1c-a5c2-b9d102c40294"
        },
        "properties": {
          "correlationId": {
            "description": "A unique identifier for the request which can aid with support requests.",
            "example": "cfadcc06-d059-4a1c-a5c2-b9d102c40294",
            "format": "uuid",
            "type": "string"
          },
          "nextCursor": {
            "description": "A pointer to the next page of results. Pass this back into the cursor query string parameter to retrieve the next page.",
            "example": "Cn8KGwoEbmFtZRITGhFBbGxpZWQgSXJpc2ggQm",
            "type": "string"
          }
        },
        "required": [
          "correlationId"
        ],
        "type": "object"
      },
      "AccountGroupWithRelations": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AccountGroup"
          },
          {
            "$ref": "#/components/schemas/AccountGroupWithRelations_allOf"
          }
        ],
        "example": {
          "id": "80eafac6-33db-478a-bcc6-adda00c9bf93",
          "externalId": "001-0000000001",
          "secondaryExternalId": "XYZ000001",
          "accountName": "John Smith - Invididual",
          "accountServicer": {
            "id": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
            "name": "Financial Platform A",
            "isActive": true,
            "hasAppStore": false,
            "defaultExpiryDays": 90,
            "hasPaymentsInitiation": true,
            "logoUri": "https://cdn.sandbox.tapico.io/images/logos/logo.png"
          },
          "servicingAgent": {
            "id": "a19811e2-4dbc-40ff-9afb-279c945217ae",
            "externalId": "002-0000051754",
            "secondaryExternalId": "EI006690000001",
            "name": "Irene Adler",
            "status": "Active",
            "address": {
              "addressLines": [
                "221b Baker St",
                "London"
              ],
              "postCode": "NW1 6XE",
              "countryCode": "GBR"
            },
            "servicingOrganisation": "039f9547-51c5-4768-89a1-79f145ef5174",
            "nationalCompetentAuthority": "FCA_GBR",
            "nationalCompetentAuthorityCode": "123456",
            "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
            "lastChangeDetectedDateTime": "2019-11-25T09:12:28.000Z"
          },
          "type": "Individual",
          "accounts": [
            {
              "id": "18c68ff9-02af-4133-9166-454918ca63cc",
              "externalId": "000-0000000001",
              "secondaryExternalId": "XYZ000001-001",
              "accountName": "John Smith - Stocks and Shares ISA",
              "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
              "baseCurrency": "GBP",
              "businessOrPersonal": "Personal",
              "sourceType": "GIA",
              "subtype": "InvestmentAccount",
              "type": "Investment",
              "openingDate": "2010-01-01T00:00:00.000Z",
              "updatedDateTime": "2019-11-20T09:12:28.000Z",
              "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
              "accountGroup": "80eafac6-33db-478a-bcc6-adda00c9bf93",
              "agentIdentifiers": [
                {
                  "identifier": 300053,
                  "identifierType": "SortCode"
                }
              ],
              "identifiers": [
                {
                  "identifier": 12345678,
                  "identifierType": "AccountNumber"
                }
              ],
              "servicingAgent": "a19811e2-4dbc-40ff-9afb-279c945217ae"
            }
          ],
          "externalAccounts": [
            {
              "id": "12b6452c-85bd-4237-8938-1f95a1521bcb",
              "externalId": "157065",
              "accountName": "John Smith - Current Account",
              "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
              "servicingAgent": "a19811e2-4dbc-40ff-9afb-279c945217ae",
              "accountGroup": "80eafac6-33db-478a-bcc6-adda00c9bf93",
              "baseCurrency": "GBP",
              "status": "Active",
              "verificationStatus": "Passed",
              "updatedDateTime": "2019-11-20T09:12:28.000Z",
              "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
              "agentIdentifiers": [
                {
                  "identifier": 200042,
                  "identifierType": "SortCode"
                }
              ],
              "identifiers": [
                {
                  "identifier": 87654321,
                  "identifierType": "AccountNumber"
                }
              ]
            }
          ],
          "openingDate": "2010-01-01T00:00:00.000Z",
          "updatedDateTime": "2019-11-20T09:12:28.000Z",
          "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
          "roles": [
            {
              "id": "5ad6553a-1de4-40fc-af88-43e438019c6a",
              "updatedDateTime": "2021-01-01T01:01:01.000Z",
              "roleType": "Individual",
              "roleTypes": [
                "Individual"
              ],
              "accountGroupId": "80eafac6-33db-478a-bcc6-adda00c9bf93",
              "customer": {
                "id": "92b74392-1c5f-4660-8d0e-78963df8b9fe",
                "type": "Individual",
                "givenName": "Motoko",
                "familyName": "Kusanagi",
                "dateOfBirth": "2004-01-20T00:00:00.000Z",
                "externalId": "015-0000358748",
                "secondaryExternalId": "358748",
                "updatedDateTime": "2019-12-01T14:57:59.000Z",
                "lastChangeDetectedDateTime": "2019-11-01T09:12:28.000Z",
                "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
                "emails": [
                  {
                    "email": "motoko.kusanagi@tapico.io",
                    "type": "Personal"
                  }
                ],
                "phoneNumbers": [
                  {
                    "number": 447777777777,
                    "type": "Personal"
                  },
                  {
                    "number": 447777777777,
                    "type": "Home"
                  }
                ]
              }
            }
          ]
        }
      },
      "AccountServicer": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AccountServicer_allOf"
          },
          {
            "$ref": "#/components/schemas/AccountServicerBase"
          },
          {
            "$ref": "#/components/schemas/AuditEntity"
          }
        ]
      },
      "AccountServicerBase": {
        "properties": {
          "organisationId": {
            "description": "Unique identifier for Organisation",
            "example": "0f40a7fd-0b2d-460f-aacc-6ff7483f7a44",
            "format": "uuid",
            "title": "Organisation ID",
            "type": "string"
          },
          "name": {
            "maxLength": 200,
            "type": "string"
          },
          "hasAppStore": {
            "description": "Indicates if the account servicer has App Store enabled.",
            "type": "boolean"
          },
          "defaultExpiryDays": {
            "description": "Indicates the default validity period for a granted consent.",
            "type": "number"
          },
          "hasPaymentsInitiation": {
            "description": "Indicates if the account servicer is supported via the Tapico Payments Initiation API.\n",
            "type": "boolean"
          },
          "logoUri": {
            "format": "uri",
            "type": "string"
          },
          "avatarUri": {
            "format": "uri",
            "type": "string"
          },
          "countryCode": {
            "description": "Country code in ISO 3166 format.",
            "type": "string"
          },
          "region": {
            "$ref": "#/components/schemas/Region"
          }
        },
        "type": "object"
      },
      "AccountServicerId": {
        "description": "Unique identifier for Account Servicer.",
        "example": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
        "format": "uuid",
        "title": "Account Servicer ID",
        "type": "string"
      },
      "AccountServicerRelation": {
        "description": "Represents the relationship to an Account Servicer resource.\n\nThis can take the value of either the related Account Servicer ID or the related Account Servicer resource, depending on whether the property has been expanded.\n\nExpand with `expand=accountServicer`.\n",
        "example": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
        "oneOf": [
          {
            "$ref": "#/components/schemas/AccountServicerId"
          },
          {
            "$ref": "#/components/schemas/AccountServicer"
          }
        ]
      },
      "AuditEntity": {
        "properties": {
          "createdDateTime": {
            "description": "Timestamp of when the record was first ingested from the source system.",
            "format": "date-time",
            "type": "string"
          },
          "updatedDateTime": {
            "description": "Timestamp of when the record was last refreshed from the source system.",
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ServicingAgentBase": {
        "description": "Represents a servicing agent entity at an account service provider such as a Financial Adviser, Wealth Manager, or other financial intermediary.",
        "example": {
          "id": "a19811e2-4dbc-40ff-9afb-279c945217ae",
          "externalId": "002-0000051754",
          "secondaryExternalId": "EI006690000001",
          "name": "Irene Adler",
          "status": "Active",
          "address": {
            "addressLines": [
              "221b Baker St",
              "London"
            ],
            "postCode": "NW1 6XE",
            "countryCode": "GBR"
          },
          "nationalCompetentAuthority": "FCA_GBR",
          "nationalCompetentAuthorityCode": "123456",
          "lastChangeDetectedDateTime": "2019-11-25T09:12:28.000Z"
        },
        "properties": {
          "id": {
            "description": "Tapico generated unique surrogate key for the Servicing Agent to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "cf4bca74-46d1-449f-b621-32be4fc315e9",
            "format": "uuid",
            "title": "Servicing Agent ID",
            "type": "string"
          },
          "externalId": {
            "description": "Primary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Identifier",
            "type": "string"
          },
          "secondaryExternalId": {
            "description": "Secondary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Secondary Identifier",
            "type": "string"
          },
          "name": {
            "maxLength": 254,
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/ServicingAgentStatus"
          },
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "nationalCompetentAuthority": {
            "$ref": "#/components/schemas/NationalCompetentAuthority"
          },
          "nationalCompetentAuthorityCode": {
            "description": "National Competent Authority registration code.",
            "maxLength": 40,
            "type": "string"
          },
          "lastChangeDetectedDateTime": {
            "description": "Timestamp of the last time a change was detected in data source.",
            "example": "2021-10-21T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "externalId",
          "id",
          "nationalCompetentAuthority",
          "status"
        ],
        "title": "Servicing Agent",
        "type": "object"
      },
      "IndividualCustomer": {
        "allOf": [
          {
            "$ref": "#/components/schemas/BaseCustomer"
          },
          {
            "$ref": "#/components/schemas/IndividualCustomer_allOf"
          }
        ],
        "example": {
          "id": "92b74392-1c5f-4660-8d0e-78963df8b9fe",
          "type": "Individual",
          "title": "Major",
          "givenName": "Motoko",
          "middleName": "Matsu",
          "familyName": "Kusanagi",
          "dateOfBirth": "2004-01-20T00:00:00.000Z",
          "retirementAge": "65",
          "retirementDate": "2064-03-22T00:00:00.000Z",
          "maritalStatus": "Single",
          "countryOfBirth": "JPN",
          "countriesOfCitizenship": [
            "JPN",
            "GBR"
          ],
          "gender": "Female",
          "externalId": "015-0000358748",
          "secondaryExternalId": "358748",
          "updatedDateTime": "2019-12-01T14:57:59.000Z",
          "lastChangeDetectedDateTime": "2019-11-01T09:12:28.000Z",
          "accountServicer": "4b6272d0-face-413a-869a-76ff9ce036ae",
          "emails": [
            {
              "email": "motoko.kusanagi@tapico.io",
              "type": "Personal"
            }
          ],
          "phoneNumbers": [
            {
              "number": 447777777777,
              "type": "Personal",
              "countryCode": "GBR"
            },
            {
              "number": 647777777777,
              "type": "Home",
              "countryCode": "NZL"
            }
          ],
          "employmentDetails": {
            "status": "Active",
            "occupation": "Developer",
            "name": "SCC company",
            "addressLines": [
              "221b Baker St",
              "London"
            ],
            "postCode": "6jq OX$",
            "countryCode": "GBR"
          },
          "taxCountries": [
            {
              "countryCode": "GBR",
              "isPrimary": true,
              "taxNumber": "SP123456C",
              "type": "NationalInsuranceNumber"
            }
          ],
          "accountRoles": [
            {
              "id": "5ad6553a-1de4-40fc-af88-43e438019c6a",
              "updatedDateTime": "2021-01-01T01:01:01.000Z",
              "roleType": "Individual",
              "roleTypes": [
                "Individual"
              ],
              "customer": "92b74392-1c5f-4660-8d0e-78963df8b9fe",
              "account": {
                "id": "18c68ff9-02af-4133-9166-454918ca63cc",
                "accountName": "Brad's Account",
                "baseCurrency": "GBP",
                "businessOrPersonal": "Personal",
                "externalId": "XYZ000001-001",
                "sourceType": "CurrentAccount",
                "subtype": "CurrentAccount",
                "type": "Deposit",
                "updatedDateTime": "2019-11-20T09:12:28.000Z",
                "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
                "accountServicer": "4b6272d0-face-413a-869a-76ff9ce036ae",
                "agentIdentifiers": [
                  {
                    "identifier": 300053,
                    "identifierType": "SortCode"
                  }
                ],
                "identifiers": [
                  {
                    "identifier": 12345678,
                    "identifierType": "AccountNumber"
                  }
                ]
              }
            }
          ]
        }
      },
      "OrganisationCustomer": {
        "allOf": [
          {
            "$ref": "#/components/schemas/BaseCustomer"
          },
          {
            "$ref": "#/components/schemas/OrganisationCustomer_allOf"
          }
        ],
        "example": {
          "id": "79a054fe-3597-491f-aa79-d3c072fe24ce",
          "type": "Organisation",
          "externalId": "015-0000358748",
          "secondaryExternalId": "358748",
          "name": "Acme Co",
          "organisationType": "Company",
          "registrationNumber": "25ad51",
          "registrationDate": "2001-01-01T00:00:00.000Z",
          "countryOfRegistration": "GBR",
          "leiCode": "33321153OF5F3MYKUV33",
          "status": "Active",
          "accountServicer": "4b6272d0-face-413a-869a-76ff9ce036ae",
          "updatedDateTime": "2019-12-01T14:57:59.000Z",
          "lastChangeDetectedDateTime": "2019-11-01T09:12:28.000Z",
          "emails": [
            {
              "email": "motoko.kusanagi@tapico.io",
              "type": "Personal"
            }
          ],
          "phoneNumbers": [
            {
              "number": 447777777777,
              "type": "Personal"
            },
            {
              "number": 447777777777,
              "type": "Home"
            }
          ],
          "taxCountries": [
            {
              "countryCode": "GBR"
            }
          ],
          "accountRoles": [
            {
              "id": "5ad6553a-1de4-40fc-af88-43e438019c6a",
              "updatedDateTime": "2021-01-01T01:01:01.000Z",
              "roleType": "Director",
              "roleTypes": [
                "Director",
                "Shareholder"
              ],
              "customer": "92b74392-1c5f-4660-8d0e-78963df8b9fe",
              "account": {
                "id": "18c68ff9-02af-4133-9166-454918ca63cc",
                "accountName": "Trading Account",
                "baseCurrency": "GBP",
                "businessOrPersonal": "Business",
                "externalId": "XYZ000001-001",
                "sourceType": "GIA",
                "subtype": "Investment",
                "type": "Investment",
                "updatedDateTime": "2019-11-20T09:12:28.000Z",
                "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
                "accountServicer": "4b6272d0-face-413a-869a-76ff9ce036ae",
                "agentIdentifiers": [
                  {
                    "identifier": 300053,
                    "identifierType": "SortCode"
                  }
                ],
                "identifiers": [
                  {
                    "identifier": 12345678,
                    "identifierType": "AccountNumber"
                  }
                ]
              }
            }
          ]
        }
      },
      "AccountGroup": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AccountGroupBase"
          },
          {
            "$ref": "#/components/schemas/AccountGroup_allOf"
          }
        ],
        "example": {
          "id": "80eafac6-33db-478a-bcc6-adda00c9bf93",
          "externalId": "001-0000000001",
          "secondaryExternalId": "XYZ000001",
          "accountName": "John Smith - Invididual",
          "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
          "servicingAgent": "a19811e2-4dbc-40ff-9afb-279c945217ae",
          "type": "Individual",
          "openingDate": "2010-01-01T00:00:00.000Z",
          "updatedDateTime": "2019-11-20T09:12:28.000Z",
          "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z"
        }
      },
      "ServicingAgentRelation": {
        "description": "Represents the relationship to an Servicing Agent resource.\n\nThis can take the value of either the related Servicing Agent ID or the related Servicing Agent resource, depending on whether the property has been expanded.\n\nExpand with `expand=servicingAgent`.\n",
        "example": "9ab395e8-ec78-4826-9aae-71ab5891b123",
        "oneOf": [
          {
            "$ref": "#/components/schemas/ServicingAgentId"
          },
          {
            "$ref": "#/components/schemas/ServicingAgent"
          }
        ]
      },
      "Account": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AccountBase"
          },
          {
            "$ref": "#/components/schemas/Account_allOf"
          }
        ],
        "example": {
          "id": "18c68ff9-02af-4133-9166-454918ca63cc",
          "externalId": "000-0000000001",
          "secondaryExternalId": "XYZ000001-001",
          "accountName": "John Smith - Stocks and Shares ISA",
          "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
          "servicingAgent": "a19811e2-4dbc-40ff-9afb-279c945217ae",
          "accountGroup": "80eafac6-33db-478a-bcc6-adda00c9bf93",
          "baseCurrency": "GBP",
          "businessOrPersonal": "Personal",
          "sourceType": "GIA",
          "subtype": "InvestmentAccount",
          "type": "Investment",
          "openingDate": "2010-01-01T00:00:00.000Z",
          "updatedDateTime": "2019-11-20T09:12:28.000Z",
          "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
          "agentIdentifiers": [
            {
              "identifier": 300053,
              "identifierType": "SortCode"
            }
          ],
          "identifiers": [
            {
              "identifier": 12345678,
              "identifierType": "AccountNumber"
            }
          ]
        }
      },
      "ExternalAccount": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ExternalAccountBase"
          },
          {
            "$ref": "#/components/schemas/Account_allOf"
          }
        ],
        "example": {
          "id": "12b6452c-85bd-4237-8938-1f95a1521bcb",
          "externalId": "157065",
          "accountName": "John Smith - Current Account",
          "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
          "servicingAgent": "a19811e2-4dbc-40ff-9afb-279c945217ae",
          "accountGroup": "80eafac6-33db-478a-bcc6-adda00c9bf93",
          "baseCurrency": "GBP",
          "type": "Deposit",
          "subType": "CurrentAccount",
          "sourceType": "BankAccount",
          "status": "Active",
          "verificationStatus": "Passed",
          "updatedDateTime": "2019-11-20T09:12:28.000Z",
          "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
          "agentIdentifiers": [
            {
              "identifier": 200042,
              "identifierType": "SortCode"
            }
          ],
          "identifiers": [
            {
              "identifier": 87654321,
              "identifierType": "AccountNumber"
            }
          ]
        }
      },
      "AccountGroupCustomerRole": {
        "description": "Represents the relationship to a Customer resource.\n\nExpand with `expand=roles`.\n",
        "example": {
          "id": "5ad6553a-1de4-40fc-af88-43e438019c6a",
          "updatedDateTime": "2021-01-01T01:01:01.000Z",
          "roleType": "Individual",
          "roleTypes": [
            "Individual"
          ],
          "accountGroupId": "80eafac6-33db-478a-bcc6-adda00c9bf93",
          "customer": {
            "id": "92b74392-1c5f-4660-8d0e-78963df8b9fe",
            "type": "Individual",
            "givenName": "Motoko",
            "familyName": "Kusanagi",
            "dateOfBirth": "2004-01-20T00:00:00.000Z",
            "externalId": "015-0000358748",
            "secondaryExternalId": "358748",
            "updatedDateTime": "2019-12-01T14:57:59.000Z",
            "lastChangeDetectedDateTime": "2019-11-01T09:12:28.000Z",
            "accountServicer": "4b6272d0-face-413a-869a-76ff9ce036ae",
            "emails": [
              {
                "email": "motoko.kusanagi@tapico.io",
                "type": "Personal"
              }
            ],
            "phoneNumbers": [
              {
                "number": 447777777777,
                "type": "Personal"
              },
              {
                "number": 447777777777,
                "type": "Home"
              }
            ]
          }
        },
        "properties": {
          "id": {
            "type": "string"
          },
          "updatedDateTime": {
            "description": "Timestamp of data refresh from source.",
            "example": "2019-11-20T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          },
          "roleType": {
            "$ref": "#/components/schemas/CustomerRoleType"
          },
          "roleTypes": {
            "items": {
              "$ref": "#/components/schemas/CustomerRoleType"
            },
            "type": "array"
          },
          "customer": {
            "$ref": "#/components/schemas/CustomerRelation"
          },
          "accountGroup": {
            "description": "Tapico generated unique surrogate key for the Account Group to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "c63901f5-f287-44c4-9079-4b960c594421",
            "format": "uuid",
            "title": "Account Group ID",
            "type": "string"
          }
        },
        "required": [
          "accountGroup",
          "customer",
          "id",
          "roleType",
          "roleTypes",
          "updatedDateTime"
        ],
        "title": "Account to Customer Role",
        "type": "object"
      },
      "AccountBase": {
        "description": "Represents a financial account held at an account service provider such as a bank or an investment platform.\n\nAccounts hold assets and liabilities e.g.; cash balance in the case of a bank account, stock holdings in a trading account, or fund holdings in a pension account.\n",
        "example": {
          "id": "18c68ff9-02af-4133-9166-454918ca63cc",
          "externalId": "000-0000000001",
          "secondaryExternalId": "XYZ000001-001",
          "accountName": "John Smith - Stocks and Shares ISA",
          "baseCurrency": "GBP",
          "businessOrPersonal": "Personal",
          "sourceType": "GIA",
          "subtype": "InvestmentAccount",
          "type": "Investment",
          "openingDate": "2010-01-01T00:00:00.000Z",
          "updatedDateTime": "2019-11-20T09:12:28.000Z",
          "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
          "agentIdentifiers": [
            {
              "identifier": 666666,
              "identifierType": "SortCode"
            }
          ],
          "identifiers": [
            {
              "identifier": 88888888,
              "identifierType": "AccountNumber"
            }
          ]
        },
        "properties": {
          "id": {
            "description": "Tapico generated unique surrogate key for the Account to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "ad862f97-928a-4ee2-b6fb-a8f6ebc80d3a",
            "format": "uuid",
            "title": "Account ID",
            "type": "string"
          },
          "externalId": {
            "description": "Primary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Identifier",
            "type": "string"
          },
          "secondaryExternalId": {
            "description": "Secondary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Secondary Identifier",
            "type": "string"
          },
          "accountName": {
            "description": "Name of account in source system.",
            "maxLength": 500,
            "type": "string"
          },
          "baseCurrency": {
            "description": "Account Base Currency - currency that assets and liabilities in the account are denoted in.",
            "type": "string"
          },
          "businessOrPersonal": {
            "$ref": "#/components/schemas/BusinessOrPersonal"
          },
          "type": {
            "$ref": "#/components/schemas/AccountType"
          },
          "subType": {
            "$ref": "#/components/schemas/AccountSubType"
          },
          "sourceType": {
            "description": "Account type as received from source system.\n",
            "type": "string"
          },
          "openingDate": {
            "description": "Account opening date.",
            "format": "date",
            "type": "string"
          },
          "updatedDateTime": {
            "description": "Timestamp of data refresh from source.",
            "example": "2019-11-20T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          },
          "lastChangeDetectedDateTime": {
            "description": "Timestamp of the last time a change was detected in data source.",
            "example": "2021-10-21T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          },
          "agentIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/AgentIdentifier"
            },
            "type": "array"
          },
          "identifiers": {
            "items": {
              "$ref": "#/components/schemas/AccountIdentifier"
            },
            "type": "array"
          }
        },
        "required": [
          "accountName",
          "agentIdentifiers",
          "baseCurrency",
          "externalId",
          "id",
          "identifiers",
          "subType",
          "type",
          "updatedDateTime"
        ],
        "type": "object"
      },
      "ExternalAccountBase": {
        "description": "External Accounts represent a record at the account service provider referring to an account held at another provider.\nFor example an investment account provider may hold references to external bank accounts that are the source or destination of funds from investment activity.\n",
        "example": {
          "id": "12b6452c-85bd-4237-8938-1f95a1521bcb",
          "externalId": "157065",
          "accountName": "John Smith - Current Account",
          "baseCurrency": "GBP",
          "type": "Deposit",
          "subType": "CurrentAccount",
          "sourceType": "BankAccount",
          "status": "Active",
          "verificationStatus": "Passed",
          "updatedDateTime": "2019-11-20T09:12:28.000Z",
          "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z",
          "agentIdentifiers": [
            {
              "identifier": 200042,
              "identifierType": "SortCode"
            }
          ],
          "identifiers": [
            {
              "identifier": 87654321,
              "identifierType": "AccountNumber"
            }
          ]
        },
        "properties": {
          "id": {
            "description": "Tapico generated unique surrogate key for the External Account to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "12b6452c-85bd-4237-8938-1f95a1521bcb",
            "format": "uuid",
            "title": "External Account ID",
            "type": "string"
          },
          "externalId": {
            "description": "Primary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Identifier",
            "type": "string"
          },
          "secondaryExternalId": {
            "description": "Secondary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Secondary Identifier",
            "type": "string"
          },
          "accountName": {
            "description": "Name of account in source system.",
            "maxLength": 500,
            "type": "string"
          },
          "baseCurrency": {
            "description": "Account Base Currency - currency that assets and liabilities in the account are denoted in.",
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/AccountType"
          },
          "subType": {
            "$ref": "#/components/schemas/AccountSubType"
          },
          "sourceType": {
            "description": "Account type as received from source system.\n",
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/ExternalAccountStatus"
          },
          "verificationStatus": {
            "$ref": "#/components/schemas/ExternalAccountVerificationStatus"
          },
          "agentName": {
            "description": "Name of the bank where the account is held.",
            "type": "string"
          },
          "agentAddress": {
            "$ref": "#/components/schemas/Address"
          },
          "availableForPlatformDeposit": {
            "description": "Defines if the account is used for depositing funds on the account servicer’s proposition.",
            "type": "boolean"
          },
          "availableForPlatformWithdrawal": {
            "description": "Defines if the account can receive fund withdrawals from the account servicer’s proposition.",
            "type": "boolean"
          },
          "updatedDateTime": {
            "description": "Timestamp of data refresh from source.",
            "example": "2019-11-20T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          },
          "lastChangeDetectedDateTime": {
            "description": "Timestamp of the last time a change was detected in data source.",
            "example": "2021-10-21T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          },
          "agentIdentifiers": {
            "items": {
              "$ref": "#/components/schemas/AgentIdentifier"
            },
            "type": "array"
          },
          "identifiers": {
            "items": {
              "$ref": "#/components/schemas/AccountIdentifier"
            },
            "type": "array"
          }
        },
        "required": [
          "accountName",
          "agentIdentifiers",
          "baseCurrency",
          "externalId",
          "id",
          "identifiers",
          "status",
          "subType",
          "type",
          "updatedDateTime",
          "verificationStatus"
        ],
        "type": "object"
      },
      "CustomerId": {
        "description": "Tapico generated unique surrogate key for the Customer to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
        "example": "ad862f97-928a-4ee2-b6fb-a8f6ebc80d3a",
        "format": "uuid",
        "title": "Customer ID",
        "type": "string"
      },
      "ServicingAgentId": {
        "description": "Tapico generated unique surrogate key for the Servicing Agent to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
        "example": "cf4bca74-46d1-449f-b621-32be4fc315e9",
        "format": "uuid",
        "title": "Servicing Agent ID",
        "type": "string"
      },
      "ServicingAgentStatus": {
        "enum": [
          "NotSpecified",
          "Active",
          "Inactive"
        ],
        "type": "string"
      },
      "Address": {
        "description": "Represents an address.",
        "example": {
          "addressLines": [
            "221b Baker St",
            "London"
          ],
          "postCode": "NW1 6XE",
          "countryCode": "GBR"
        },
        "properties": {
          "addressLines": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "postCode": {
            "type": "string"
          },
          "countryCode": {
            "description": "Country code in ISO 3166 format.",
            "example": "GBR",
            "type": "string"
          }
        },
        "required": [
          "addressLines"
        ],
        "title": "Address",
        "type": "object"
      },
      "NationalCompetentAuthority": {
        "description": "Jurisdictional financial regulatory body.",
        "enum": [
          "NotSpecified",
          "ASIC_AUS",
          "FCA_GBR",
          "FMA_NZL",
          "HKMA_HKG",
          "MAS_SGP"
        ],
        "title": "National Competent Authority",
        "type": "string"
      },
      "BaseCustomer": {
        "description": "Entity representing the owner of an account.",
        "properties": {
          "id": {
            "description": "Tapico generated unique surrogate key for the Customer to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "ad862f97-928a-4ee2-b6fb-a8f6ebc80d3a",
            "format": "uuid",
            "title": "Customer ID",
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/CustomerType"
          },
          "externalId": {
            "description": "Primary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Identifier",
            "type": "string"
          },
          "secondaryExternalId": {
            "description": "Secondary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Secondary Identifier",
            "type": "string"
          },
          "sourceSystemId": {
            "$ref": "#/components/schemas/SourceSystemEntityIdentifier"
          },
          "updatedDateTime": {
            "description": "Timestamp of data refresh from source.",
            "example": "2019-11-20T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          },
          "emails": {
            "items": {
              "$ref": "#/components/schemas/CustomerEmail"
            },
            "type": "array"
          },
          "phoneNumbers": {
            "items": {
              "$ref": "#/components/schemas/CustomerPhoneNumber"
            },
            "type": "array"
          },
          "taxCountries": {
            "items": {
              "$ref": "#/components/schemas/TaxIdentifier"
            },
            "type": "array"
          }
        },
        "required": [
          "externalId",
          "id"
        ],
        "type": "object"
      },
      "CustomerMaritalStatusType": {
        "description": "Customer Marital Status",
        "enum": [
          "NotSpecified",
          "Married",
          "Separated",
          "CivilPartner",
          "Divorced",
          "Widowed",
          "Single",
          "Partner"
        ],
        "type": "string"
      },
      "CustomerGenderType": {
        "description": "Customer Gender",
        "enum": [
          "NotSpecified",
          "Male",
          "Female"
        ],
        "type": "string"
      },
      "EmploymentDetails": {
        "example": {
          "status": "Employed",
          "occupation": "Developer",
          "employerName": "SCC company",
          "employerAddress": {
            "addressLines": [
              "221b Baker St",
              "London"
            ],
            "postCode": "6jq OX$",
            "countryCode": "GBR"
          }
        },
        "properties": {
          "status": {
            "$ref": "#/components/schemas/CustomerEmploymentStatusType"
          },
          "occupation": {
            "maxLength": 254,
            "type": "string"
          },
          "employerName": {
            "maxLength": 254,
            "type": "string"
          },
          "employerAddress": {
            "$ref": "#/components/schemas/Address"
          }
        }
      },
      "CustomerRoleType": {
        "description": "The type of role which a customer has to an account.",
        "enum": [
          "NotSpecified",
          "AuthorisedSignatory",
          "Beneficiary",
          "Dependent",
          "Director",
          "Disclosure",
          "Employer",
          "Executor",
          "ExSpouse",
          "Individual",
          "Joint",
          "LegalRepresentative",
          "LetterOfAuthority",
          "LifeAssured",
          "Nominee",
          "Organisation",
          "Owner",
          "PartnerOfAccountHolder",
          "PowerOfAttorney",
          "Protector",
          "RegisteredContact",
          "SeniorManager",
          "Settlor",
          "Shareholder",
          "ShareholderGT25",
          "ThirdParty",
          "ThirdPartyPayer",
          "TrustAppointer",
          "TrustController",
          "Trustee"
        ],
        "type": "string"
      },
      "AccountGroupBase": {
        "description": "Represents a grouping of Accounts, for example, a logical grouping of products such a ISA's and GIA's jointly held my multiple account owners.",
        "example": {
          "id": "80eafac6-33db-478a-bcc6-adda00c9bf93",
          "externalId": "001-0000000001",
          "secondaryExternalId": "XYZ000001",
          "accountName": "John Smith - Invididual",
          "type": "Individual",
          "openingDate": "2010-01-01T00:00:00.000Z",
          "updatedDateTime": "2019-11-20T09:12:28.000Z",
          "lastChangeDetectedDateTime": "2019-11-10T09:12:28.000Z"
        },
        "properties": {
          "id": {
            "description": "Tapico generated unique surrogate key for the Account Group to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "c63901f5-f287-44c4-9079-4b960c594421",
            "format": "uuid",
            "title": "Account Group ID",
            "type": "string"
          },
          "externalId": {
            "description": "Primary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Identifier",
            "type": "string"
          },
          "secondaryExternalId": {
            "description": "Secondary identifier from the system this entity was imported from.",
            "maxLength": 210,
            "title": "External Entity Secondary Identifier",
            "type": "string"
          },
          "accountName": {
            "description": "Name of Account Group in source system.",
            "maxLength": 500,
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/AccountGroupType"
          },
          "openingDate": {
            "description": "Account Group opening date.",
            "format": "date",
            "type": "string"
          },
          "updatedDateTime": {
            "description": "Timestamp of data refresh from source.",
            "example": "2019-11-20T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          },
          "lastChangeDetectedDateTime": {
            "description": "Timestamp of the last time a change was detected in data source.",
            "example": "2021-10-21T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "accountName",
          "externalId",
          "id",
          "type",
          "updatedDateTime"
        ],
        "title": "Account Group",
        "type": "object"
      },
      "ServicingAgent": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ServicingAgentBase"
          },
          {
            "$ref": "#/components/schemas/ServicingAgent_allOf"
          }
        ],
        "example": {
          "id": "a19811e2-4dbc-40ff-9afb-279c945217ae",
          "externalId": "002-0000051754",
          "secondaryExternalId": "EI006690000001",
          "name": "Irene Adler",
          "status": "Active",
          "address": {
            "addressLines": [
              "221b Baker St",
              "London"
            ],
            "postCode": "NW1 6XE",
            "countryCode": "GBR"
          },
          "servicingOrganisation": "039f9547-51c5-4768-89a1-79f145ef5174",
          "nationalCompetentAuthority": "FCA_GBR",
          "nationalCompetentAuthorityCode": "123456",
          "accountServicer": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
          "lastChangeDetectedDateTime": "2019-11-25T09:12:28.000Z"
        }
      },
      "CustomerRelation": {
        "description": "Represents the relationship to a Customer resource.\n\nThis can take the value of either related Individual or Customer resource.\n\nExpand with `expand=roles.customer`.\n",
        "example": "92b74392-1c5f-4660-8d0e-78963df8b9fe",
        "oneOf": [
          {
            "$ref": "#/components/schemas/CustomerId"
          },
          {
            "$ref": "#/components/schemas/IndividualCustomer"
          },
          {
            "$ref": "#/components/schemas/OrganisationCustomer"
          }
        ]
      },
      "BusinessOrPersonal": {
        "description": "For bank and current accounts this identifies whether the account is a personal or business account.",
        "enum": [
          "Personal",
          "Business"
        ],
        "type": "string"
      },
      "AccountType": {
        "description": "Top level account category.",
        "enum": [
          "NotSpecified",
          "Credit",
          "Deposit",
          "Investment",
          "Loan",
          "Other"
        ],
        "type": "string"
      },
      "AccountSubType": {
        "description": "Account sub category",
        "enum": [
          "NotSpecified",
          "CashAccount",
          "CashISA",
          "ChargeCard",
          "CreditCard",
          "CurrentAccount",
          "EMoney",
          "InvestmentAccount",
          "ISA",
          "JuniorISA",
          "JuniorSIPP",
          "Loan",
          "MarginLendingAccount",
          "Mortgage",
          "NoticeAccount",
          "OffshoreBond",
          "OnshoreBond",
          "ORSO",
          "Pension",
          "PersonalEquityPlan",
          "PrePaidCard",
          "ProtectedRightsPension",
          "RetirementAccumulation",
          "RetirementDrawdown",
          "SavingsAccount",
          "SIPP",
          "ThirdPartyOffshoreBond",
          "ThirdPartyOnshoreBond",
          "ThirdPartyPension"
        ],
        "type": "string"
      },
      "AgentIdentifier": {
        "properties": {
          "identifierType": {
            "$ref": "#/components/schemas/AgentIdentifierType"
          },
          "identifier": {
            "example": "223344",
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "identifierType"
        ],
        "type": "object"
      },
      "AccountIdentifier": {
        "properties": {
          "identifierType": {
            "$ref": "#/components/schemas/AccountIdentifierType"
          },
          "identifier": {
            "example": "12345678",
            "type": "string"
          }
        },
        "required": [
          "identifier",
          "identifierType"
        ],
        "type": "object"
      },
      "ExternalAccountStatus": {
        "description": "External Account Status.",
        "enum": [
          "NotSpecified",
          "Inactive",
          "AwaitingAuthorisation",
          "Active"
        ],
        "type": "string"
      },
      "ExternalAccountVerificationStatus": {
        "description": "External Account Verification Status.",
        "enum": [
          "NotSpecified",
          "Error",
          "Failed",
          "Referred",
          "Passed"
        ],
        "type": "string"
      },
      "AccountIdentifierType": {
        "description": "Specifies the type of account identifier.",
        "enum": [
          "AccountNumber",
          "IBAN",
          "PAN",
          "BBAN",
          "Paym"
        ],
        "type": "string"
      },
      "AgentIdentifierType": {
        "description": "Specifies the type of agent identifier.",
        "enum": [
          "BIC",
          "SortCode"
        ],
        "type": "string"
      },
      "SourceSystemEntityIdentifier": {
        "description": "Entity identifier from the source system the entity was originally created at.",
        "properties": {
          "applicationName": {
            "description": "Name of the source system where this entity was originally created at, if created via the Tapico API.",
            "example": "Iress Xplan",
            "type": "string"
          },
          "applicationId": {
            "description": "Unique identifier for Application.",
            "example": "9588b9e9-9f1d-4943-b547-70b809c30db8",
            "format": "uuid",
            "title": "Application ID",
            "type": "string"
          },
          "identifier": {
            "example": "ABC123",
            "type": "string"
          }
        },
        "required": [
          "identifier"
        ],
        "title": "Source System Entity Identifier",
        "type": "object"
      },
      "CustomerEmail": {
        "description": "Customer email address.\n",
        "example": {
          "type": "Personal",
          "email": "motoko.kusanagi@tapico.io"
        },
        "properties": {
          "email": {
            "format": "email",
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/CustomerEmailType"
          }
        },
        "required": [
          "email"
        ],
        "type": "object"
      },
      "CustomerPhoneNumber": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PhoneNumber"
          },
          {
            "$ref": "#/components/schemas/CustomerPhoneNumber_allOf"
          }
        ]
      },
      "TaxIdentifier": {
        "example": {
          "countryCode": "GBR",
          "isPrimary": false,
          "taxNumber": "65465-adg",
          "type": "EmployerIdentificationNumber"
        },
        "properties": {
          "countryCode": {
            "description": "Country code in ISO 3166 format.",
            "example": "GBR",
            "type": "string"
          },
          "isPrimary": {
            "type": "boolean"
          },
          "taxNumber": {
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/CustomerTaxType"
          }
        },
        "required": [
          "countryCode"
        ]
      },
      "CustomerEmploymentStatusType": {
        "enum": [
          "NotSpecified",
          "Employed",
          "SelfEmployed",
          "Retired",
          "CaringForAPersonUnder16",
          "CaringForAPersonOver16",
          "ChildUnder16",
          "FullTimeEducation",
          "Unemployed",
          "Partner",
          "Other"
        ],
        "type": "string"
      },
      "AccountGroupType": {
        "description": "Account group type.",
        "enum": [
          "NotSpecified",
          "Individual",
          "Joint",
          "Company",
          "Trust",
          "Charity",
          "Group",
          "ThirdParty",
          "Association",
          "Pension",
          "SMSF",
          "Junior",
          "Erisa",
          "Member"
        ],
        "type": "string"
      },
      "CustomerEmailType": {
        "enum": [
          "NotSpecified",
          "Business",
          "Mobile",
          "Other",
          "Personal",
          "Work"
        ],
        "type": "string"
      },
      "PhoneNumber": {
        "description": "Phone number",
        "example": {
          "number": 447777777777,
          "countryCode": "GBR"
        },
        "properties": {
          "countryCode": {
            "description": "Country code in ISO 3166 format.",
            "example": "GBR",
            "type": "string"
          },
          "number": {
            "description": "E.164 format phone number",
            "type": "string"
          }
        },
        "required": [
          "countryCode",
          "number"
        ],
        "title": "Phone Number",
        "type": "object"
      },
      "CustomerPhoneNumberType": {
        "enum": [
          "NotSpecified",
          "Business",
          "Fax",
          "Home",
          "Mobile",
          "Other",
          "Work"
        ],
        "type": "string"
      },
      "CustomerTaxType": {
        "enum": [
          "NotSpecified",
          "EmployerIdentificationNumber",
          "IndividualTaxpayerIdentificationNumber",
          "InlandRevenueDepartmentNumber",
          "NationalInsuranceNumber",
          "NationalRegistrationIdentityCardNumber",
          "PendingAdoptionsTaxpayerIdentificationNumber",
          "SocialSecurityNumber",
          "TaxFileNumber",
          "TaxpayerIdentificationNumber",
          "ForeignIdentificationNumber",
          "TaxNumber",
          "FiscalCode",
          "SwedishPersonalNumber"
        ],
        "type": "string"
      },
      "AccountGroupWithRelations_allOf": {
        "properties": {
          "accountServicer": {
            "$ref": "#/components/schemas/AccountServicerRelation"
          },
          "servicingAgent": {
            "$ref": "#/components/schemas/ServicingAgentRelation"
          },
          "accounts": {
            "description": "Accounts belonging to the account group.\n\nExpand with `expand=accounts`.\n",
            "items": {
              "$ref": "#/components/schemas/Account"
            },
            "type": "array"
          },
          "externalAccounts": {
            "description": "External Accounts associated with the account group.\n\nRequires `ReadExternalAccounts` consent.\nExpand with `expand=externalAccounts`.\n",
            "items": {
              "$ref": "#/components/schemas/ExternalAccount"
            },
            "type": "array"
          },
          "roles": {
            "description": "Customer relations for the account group.\n\nExpand with `expand=roles`.\n",
            "items": {
              "$ref": "#/components/schemas/AccountGroupCustomerRole"
            },
            "type": "array"
          }
        },
        "required": [
          "accountServicer"
        ],
        "type": "object"
      },
      "AccountServicer_allOf": {
        "description": "An account service provider such as a bank, pension provider, or investment and savings platform.\n",
        "example": {
          "id": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
          "organisationId": "0f40a7fd-0b2d-460f-aacc-6ff7483f7a44",
          "name": "Financial Platform A",
          "isActive": true,
          "hasAppStore": false,
          "defaultExpiryDays": 90,
          "hasPaymentsInitiation": true,
          "logoUri": "https://cdn.sandbox.tapico.io/images/logos/logo.png",
          "countryCode": "GBR",
          "region": "EU"
        },
        "properties": {
          "id": {
            "description": "Unique identifier for Account Servicer.",
            "example": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
            "format": "uuid",
            "title": "Account Servicer ID",
            "type": "string"
          },
          "isActive": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "isActive"
        ],
        "type": "object"
      },
      "IndividualCustomer_allOf": {
        "description": "Entity representing the owner of an account.",
        "properties": {
          "accountServicer": {
            "description": "Unique identifier for Account Servicer.",
            "example": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
            "format": "uuid",
            "title": "Account Servicer ID",
            "type": "string"
          },
          "title": {
            "maxLength": 254,
            "type": "string"
          },
          "givenName": {
            "maxLength": 254,
            "type": "string"
          },
          "middleName": {
            "maxLength": 254,
            "type": "string"
          },
          "familyName": {
            "maxLength": 254,
            "type": "string"
          },
          "dateOfBirth": {
            "format": "date",
            "type": "string"
          },
          "retirementAge": {
            "type": "number"
          },
          "retirementDate": {
            "format": "date",
            "type": "string"
          },
          "maritalStatus": {
            "$ref": "#/components/schemas/CustomerMaritalStatusType"
          },
          "gender": {
            "$ref": "#/components/schemas/CustomerGenderType"
          },
          "lastChangeDetectedDateTime": {
            "description": "Timestamp of the last time a change was detected in data source.",
            "example": "2021-10-21T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          },
          "countryOfBirth": {
            "description": "Country code in ISO 3166 format.",
            "example": "GBR",
            "maxLength": 3,
            "type": "string"
          },
          "countriesOfCitizenship": {
            "items": {
              "description": "Country code in ISO 3166 format.",
              "example": "USA",
              "maxLength": 3,
              "type": "string"
            },
            "type": "array"
          },
          "employmentDetails": {
            "$ref": "#/components/schemas/EmploymentDetails"
          }
        },
        "type": "object"
      },
      "OrganisationCustomer_allOf": {
        "description": "Entity representing the owner of an account.\n",
        "properties": {
          "accountServicer": {
            "description": "Unique identifier for Account Servicer.",
            "example": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
            "format": "uuid",
            "title": "Account Servicer ID",
            "type": "string"
          },
          "name": {
            "maxLength": 254,
            "type": "string"
          },
          "organisationType": {
            "maxLength": 40,
            "type": "string"
          },
          "registrationNumber": {
            "type": "string"
          },
          "registrationDate": {
            "format": "date",
            "type": "string"
          },
          "countryOfRegistration": {
            "description": "Country code currency in ISO 3166 format.",
            "maxLength": 50,
            "type": "string"
          },
          "leiCode": {
            "type": "string"
          },
          "status": {
            "maxLength": 40,
            "type": "string"
          },
          "lastChangeDetectedDateTime": {
            "description": "Timestamp of the last time a change was detected in data source.",
            "example": "2021-10-21T09:12:28.000Z",
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object"
      },
      "AccountGroup_allOf": {
        "description": "Represents a grouping of Accounts, for example, a logical grouping of products such a ISA's and GIA's jointly held my multiple account owners.\n",
        "properties": {
          "accountServicer": {
            "description": "Unique identifier for Account Servicer.",
            "example": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
            "format": "uuid",
            "title": "Account Servicer ID",
            "type": "string"
          },
          "servicingAgent": {
            "description": "Tapico generated unique surrogate key for the Servicing Agent to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "cf4bca74-46d1-449f-b621-32be4fc315e9",
            "format": "uuid",
            "title": "Servicing Agent ID",
            "type": "string"
          }
        },
        "required": [
          "accountServicer"
        ],
        "type": "object"
      },
      "Account_allOf": {
        "properties": {
          "accountServicer": {
            "description": "Unique identifier for Account Servicer.",
            "example": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
            "format": "uuid",
            "title": "Account Servicer ID",
            "type": "string"
          },
          "servicingAgent": {
            "description": "Tapico generated unique surrogate key for the Servicing Agent to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "cf4bca74-46d1-449f-b621-32be4fc315e9",
            "format": "uuid",
            "title": "Servicing Agent ID",
            "type": "string"
          },
          "accountGroup": {
            "description": "Tapico generated unique surrogate key for the Account Group to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "c63901f5-f287-44c4-9079-4b960c594421",
            "format": "uuid",
            "title": "Account Group ID",
            "type": "string"
          }
        },
        "required": [
          "accountGroup",
          "accountServicer"
        ],
        "type": "object"
      },
      "ServicingAgent_allOf": {
        "properties": {
          "servicingOrganisation": {
            "description": "Tapico generated unique surrogate key for the Servicing Organisation to deal with potential identifier conflicts across account servicers.\n\nRefer to `externalId` and `secondaryExternalId` for the origin system identifiers.\n",
            "example": "f6dc8217-d507-4ba6-805c-dbe6034d25f5",
            "format": "uuid",
            "title": "Servicing Organisation ID",
            "type": "string"
          },
          "accountServicer": {
            "description": "Unique identifier for Account Servicer.",
            "example": "b83b4fc3-d970-4665-aab4-8d7e0fe1d982",
            "format": "uuid",
            "title": "Account Servicer ID",
            "type": "string"
          }
        },
        "required": [
          "accountServicer"
        ],
        "type": "object"
      },
      "CustomerPhoneNumber_allOf": {
        "description": "Customer Phone Number",
        "example": {
          "type": "Home",
          "countryCode": "GBR",
          "number": 447777777777
        },
        "properties": {
          "type": {
            "$ref": "#/components/schemas/CustomerPhoneNumberType"
          }
        },
        "required": [
          "countryCode",
          "number",
          "type"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearer": {
        "bearerFormat": "jwt",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```