AM/FA/Inv - Get Organization Details

Details

/external/v1/org

Synopsis

Get Organization Details

get

This route is used to retrieve the details of an organization given a set of filters such as organization identifiers or organization type. This endpoint returns paginated data. Up to 50 can be extracted per call. This endpoint can be called by applications with access to scope "readOrgs".

Required scopes

This endpoint requires the following scopes:

• : readOrgs

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

orgIdsFilterstringOptional

The comma delimited list of organization ids to filter the organization records. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

orgStatusFilterstringOptional

The comma delimited list of statuses to filter the organization records. Up to 5 entries can be provided. Available values: failed_creation, added, ready, suspended, removed

Example: ready,added

orgTypeFilterstringOptional

The comma delimited list of types to filter the organization records. Up to 5 entries can be provided. Available values: issuer, investor, asset_manager, administrator, fund_admin

Example: investor,fund_admin

orgCorrelationIdsFilterstringOptional

The comma delimited list of organization correlation ids to filter the organization records. Up to 25 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

orgCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "orgCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

Responses

200

Successfully retrieved the Organization details

application/json

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/org

HTTPcURLJavaScriptPython

GET /external/v1/org HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "name": "Bank Name",
    "outboundAddressList": [
      {
        "ip": "127.0.0.1",
        "address": "outbound.atorg.com"
      }
    ],
    "integrationApiAddress": "https://integration-api.atorg.com",
    "type": "investor",
    "status": "added",
    "locked": false,
    "peers": [
      {
        "key": "peer01",
        "domainName": "peer123.atorg.com",
        "requestPort": 65535,
        "eventPort": 65534
      }
    ],
    "orderers": [
      {
        "key": "orderer01",
        "domainName": "orderer123.atorg.com",
        "requestPort": 65535,
        "adminPort": 65534,
        "healthCheckPort": 65533
      }
    ],
    "orgACL": [
      "US9QIMA",
      "US9QIMB"
    ],
    "createdDate": "2024-09-12T00:00:00.000Z",
    "updatedDate": "2024-09-12T00:00:00.000Z",
    "orgId": "US9QIMA",
    "whitelisted": false,
    "correlationData": [
      {
        "correlationId": "org717",
        "origin": "Identifies organization on backoffice",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        },
        "extraData": {
          "some": "Custom Property"
        }
      }
    ]
  }
]