AM - Get Assigned Service Providers

Service providers are third-party organizations, such as fund administrators, that take part in tasks associated with the lifecycle of an offering.

Details

/external/v1/service-providers

Synopsis

Get Service Providers

get

This route is used to extract all the service providers that have been assigned to an offering specified by a set of search filters. This endpoint is paginated, up to 50 records can be retrieved per call. This endpoint can be called by applications with access to scope "readServiceProviders".

Required scopes

This endpoint requires the following scopes:

• : readServiceProviders

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 assignment records. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

securityIdsFilterstringOptional

The comma delimited list of security ids to filter the assignment records. Up to 10 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

securityCorrelationIdsFilterstringOptional

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

Example: 1234,5678,7890

securityCorrelationOrgIdstring · max: 12Optional

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

assignmentStatusFilterstringOptional

The comma delimited list of statuses to filter the assignment records. Up to 4 entries can be provided. Available values: assigned, accepted, rejected, inactive

Example: assigned,accepted

Responses

200

Successfully extracted data

application/json

orgIdstringRequired

The id of the assigned organization. Used to uniquely identify the organization on the ledger

Example: US9QIMA

namestringRequired

The name of the assigned organization

Example: State Street

statusall ofRequired

The status of the assignment: - assigned: eligible to be accepted/rejected - accepted: eligible to be rejected - rejected: eligible to be accepted - inactive: it means that the organization is not assigned to this particular security. The typical use case is when an investing organization is only assigned to a subset of share classes. All the share classes to which the investing organization was not assigned to will have this status. Also, if an organization was removed from the exclusivity list it will also have this status.

Example: assigned

string · enumOptional

The status of the assignment: - assigned: eligible to be accepted/rejected - accepted: eligible to be rejected - rejected: eligible to be accepted - inactive: it means that the organization is not assigned to this particular security. The typical use case is when an investing organization is only assigned to a subset of share classes. All the share classes to which the investing organization was not assigned to will have this status. Also, if an organization was removed from the exclusivity list it will also have this status.

Possible values:

roleall ofRequired

The role of assigned organization.

Example: service_provider

string · enumOptional

The role of assigned organization.

Possible values:

securityIdstringRequired

The id of the security organization is assigned to. Used to uniquely identify the security on the ledger

Example: USCCWSF01I01

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/service-providers

HTTPcURLJavaScriptPython

GET /external/v1/service-providers HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "orgId": "US9QIMA",
    "name": "State Street",
    "status": "assigned",
    "role": "service_provider",
    "securityId": "USCCWSF01I01"
  }
]

Important Notes

• securityId: uniquely identifies the fund/offering. See Managing the SecurityId.