Coverage¶

The Coverage service provides functionality to create, amend and view Investor Coverage and permissions, across the full set of supported asset classes.

Base Urls¶

The Coverage service base Urls are as follows:

Service Root	/book-building/coverage
Health Check	/book-building/coverage/hc/status
Swagger/Open API	/book-building/coverage/docs/index.html

API Endpoints¶

The full list of available API endpoints is show below, grouped by resource, with links to the detailed documentation for each. For a concise, structured definition please reference the Swagger/Open API specification.

Contacts:

Name	Method	Url	Description
Search Contacts	Search	/v1/contacts/search	Search Contact using search criteria
Get Contact by ID	Get	/v1/contacts/{id}	Get a Contact by ID
Get Contact by Source ID	Get	/v1/contacts	Get a Contact by Source ID
Create Contact	Post	/v1/contacts	Create a Contact
Delete Contact by ID	Delete	/v1/contacts/{id}	Delete a Contact by ID
Delete Contact by Source ID	Delete	/v1/contacts	Delete a Contact by Source ID
Update Contact	Put	/v1/contacts	Update a Contact
Update Contact by ID	Patch	/v1/contacts/{id}	Update specific attributes of a Contact

Groups:

Name	Method	Url	Description
Search Group	Search	/v4/groups/search	Search Group using specified search criteria
Get Group by ID	Get	/v4/groups/{id}	Get covered Group by user ID
Get Group by Source ID	Get	/v4/groups	Get covered Group by user SourceId
Create Group	Post	/v4/groups	Create a Group
Delete Group by ID	Delete	/v4/groups/{id}	Delete a Group by ID
Delete Group by Source ID	Delete	/v4/groups	Delete a Group by Source ID
Update Group	Put	/v4/groups	Update a specific Group

Investor Account Contact:

Name	Method	Url	Description
Search Investor Account Contact	Post	/v1/investor-account-contacts/search	Search for Investor Account Contact
Advanced Search Investor Account Contact	Post	/v1/investor-account-contacts/advanced-search	Search for Investor Account Contact
Get Investor Account Contact by ID	Get	/v1/investor-account-contacts/{id}	Get Investor Account Contact by ID
Get Investor Account Contact by Source ID	Get	/v1/investor-account-contacts	Get Investor Account Contact by Source ID
Get My Coverage - Investor Account Contact	Get	/v1/investor-account-contacts/my-coverage	Get coverage for Investor Account Contact
Create Investor Account Contact	Post	/v1/investor-account-contacts	Create Investor Account Contact
Delete Investor Account Contact by ID	Delete	/v1/investor-account-contacts/{id}	Delete Investor Account Contact by ID
Delete Investor Account Contact by Source ID	Delete	/v1/investor-account-contacts	Delete Investor Account Contact by Source ID
Update Investor Account Contact	Put	/v1/investor-account-contacts	Update an Investor Account Contact
Patch Investor Account Contact	Patch	/v1/investor-account-contacts/{id}	Patch an Investor Account Contact

Investor Account Group:

Name	Method	Url	Description
Search Investor Account Group	Post	/v4/investor-account-groups/search	Search for Investor Account - Group Relations
Create Investor Account Group	Post	/v4/investor-account-groups	Assign a specific Investor Account - Group Relation
Delete Investor Account From Group	Delete	/v4/investor-account-groups/delete	Delete a specific Investor Account - Group Relation

Investor Accounts:

Name	Method	Url	Description
Search Investor Account	Post	/v3/investor-accounts/search	Searches Investor Accounts
Get Investor Account by ID	Get	/v3/investor-accounts/{id}	Get Investor Accounts by ID
Get Investor Account by Source ID	Get	/v3/investor-accounts	Get Investor Accounts by Source ID
Get My Coverage	Get	/v3/investor-accounts/my-coverage	Gets my coverage
Get Investor Account Coverage Search	Get	/v3/investor-accounts/coverage/search	Gets Investor Account coverage using Search
Get User Coverage for Investor Account	Post	/v3/investor-accounts/user-coverage	Gets the user coverage for InvestorAccount
Create Investor Account	Post	/v3/investor-accounts	Creates an Investor Account
Update Investor Account	Put	/v3/investor-accounts	Update an Investor Account
Update Investor Account by ID	Patch	/v3/investor-accounts/{id}	Update an Investor Account by ID

Compliance Letter Request:

Name	Method	Url	Description
Create Compliance Letter Request	Post	/v1/investor-account/{id}/compliance-letter-request/{complianceType}	Creates Compliance Letter Request

User Groups:

Name	Method	Url	Description
Search User Group	Post	/v4/user-groups/search	Search User - Group Relation with search criteria
Create User Group	Post	/v4/user-groups	Create a User - Group Relation
Delete User From Group	Delete	/v4/user-groups/{id}	Delete a User from Group by ID

Investor Accounts Summary:

Name	Method	Url	Description
Search Investor Accounts Summary	Post	/v1/investor-accounts-summary/search	The Search Investor Accounts Summary endpoint provides a way of accessing a summary of Investor Account and Investor Account Contact objects based on the search fields.

Search Criteria

The search criteria for Orders services is displayed below.

{
        "criteria": [{
                        "field": "string",
                        "operator": "=",
                        "value": "string"
                }
        ]
}

Contacts¶

Search Contacts¶

The search Contacts endpoint provides a way of accessing a collection of Contact objects based on the search fields.

Authorization

In order to access the Contacts information, it is required to have the coverage-contacts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Contact Objects. The pagination is in the standard CAS format as described in Pagination.

Get Contact by ID¶

The get Contacts endpoint provides a way of accessing a specific Contact object by ID.

Authorization

In order to access the Contacts information, it is required to have the coverage-contacts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
id	UUID	URL path	The unique CAS id of the Contact to retrieve

Response

The endpoint returns a JSON response containing an Contact Object.

Get Contact by Source ID¶

This get Contact endpoint provides a way of retrieving a specific Contact object by source application id. It is for use when the CAS unique id is not known, such as when being invoked by a source application.

Authorization

In order to access the Contacts information, it is required to have the coverage-contacts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique Source id of the Contact to retrieve

Response

The endpoint returns a JSON response containing an Contact Object.

Create Contact¶

The Create Contact endpoint provides a way of creating an Contact object in the CAS system.

Authorization

In order to access the Contacts information, it is required to have the coverage-contacts-write scope in the access token.

Parameters

This endpoint accepts an Contact object as its body. An example JSON payload can be found in the Swagger/OpenAPI reference.

Response

The endpoint returns a JSON payload containing the newly created Contact Object.

Delete Contact by ID¶

The Delete Contact endpoint provides a way of deleting a Contact object in the CAS system.

Authorization

In order to access the Contact information, it is required to have the coverage-contacts-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
id	UUID	URL path	The unique id of the Contact to delete.

Delete Contact by Source ID¶

This delete Contact endpoint provides a way of deleting a specific Contact object by source application id. It is for use when the CAS unique id is not known, such as when being invoked by a source application.

Authorization

In order to access the Contact information, it is required to have the coverage-contacts-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique source id of the Contact to delete.

Update Contact¶

The Update Contact endpoint provides a way of updating a specific Contact object.

Authorization

In order to access the Contacts information, it is required to have the coverage-contacts-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a Contact object to be updated, including the current row version.

Response

The endpoint returns a JSON payload containing the newly updated Contact object.

Update Contact by ID¶

The Update Contact endpoint provides a way of updating specific attributes of a Contact object.

Authorization

In order to update the Contacts information, it is required to have the coverage-contacts-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a list of patchable attributes to be updated in the existing Contact.

Patchable Attributes:: Type, isActive, firstName, middleName, lastName, email, detailData, sourceId, sourceRowVersion, types

Response

The endpoint returns a JSON payload containing the newly updated Contact object.

Groups¶

Search Group¶

The search Group endpoint provides a way of accessing a collection of Group objects based on the search fields.

Authorization

In order to access the Groups information, it is required to have the coverage-groups-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Group Objects. The pagination is in the standard CAS format as described in Pagination.

Get Group by ID¶

The get Group endpoint provides a way of accessing a specific Group object by ID.

Authorization

In order to access the Groups information, it is required to have the coverage-groups-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
id	UUID	URL path	The unique CAS id of the Group to retrieve

Response

The endpoint returns a JSON response containing an Group Object.

Get Group by Source ID¶

This get Group endpoint provides a way of retrieving a specific Group object by source application id. It is for use when the CAS unique id is not known, such as when being invoked by a source application.

Authorization

In order to access the Groups information, it is required to have the coverage-groups-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique source id of the Group to retrieve

Response

The endpoint returns a JSON response containing an Group Object.

Create Group¶

The Create Group endpoint provides a way of creating a Group object in the CAS system.

Authorization

In order to access the Groups information, it is required to have the groups-write scope in the access token.

Parameters

This endpoint accepts a Group object as its body, as displayed in the schema.

Response

The endpoint returns a JSON payload containing the newly created Group Object.

Delete Group by ID¶

The Delete Group endpoint provides a way of deleting a Group object in the CAS system.

Authorization

In order to access the Group information, it is required to have the groups-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
id	UUID	URL path	The unique id of the Group to delete.

Delete Group by Source ID¶

This delete Group endpoint provides a way of deleting a specific Group object by source application id. It is for use when the CAS unique id is not known, such as when being invoked by a source application.

Authorization

In order to access the Group information, it is required to have the groups-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique source id of the Group to delete.

Update Group¶

The Update Group endpoint provides a way of updating a specific Group object.

Authorization

In order to access the Groups information, it is required to have the groups-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a Group object to be updated.

Response

The endpoint returns a JSON payload containing the new, updated Group object.

Investor Account Contact¶

Search Investor Account Contact¶

The search Investor Account Contact endpoint provides a way of accessing a collection of Investor Account Contact objects based on the search fields.

Authorization

In order to access the Investor Account Contacts information, it is required to have the investor-account-contacts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Investor Account Contact Objects. The pagination is in the standard CAS format as described in Pagination.

Advanced Search Investor Account Contact¶

The advanced search Investor Account Contact endpoint provides a way of accessing a collection of Investor Account Contact objects based on the search fields.

Authorization

In order to access the Investor Account Contacts information, it is required to have the investor-account-contacts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	object	Form Data	See Advanced Search Criteria
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Investor Account Contact Objects. The pagination is in the standard CAS format as described in Pagination.

Get Investor Account Contact by ID¶

The get Investor Account Contact endpoint provides a way of accessing a specific Investor Account Contact object by CAS id.

Authorization

In order to access the Investor Account Contacts information, it is required to have the investor-account-contacts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
id	UUID	URL path	The unique id of the Investor Account Contact to retrieve

Get Investor Account Contact by Source ID¶

This get Investor Account Contact endpoint provides a way of retrieving a specific Investor Account Contact object by source application id. It is for use when the CAS unique id is not known, such as when being invoked by a source application.

Authorization

In order to access the Investor Account Contacts information, it is required to have the investor-account-contacts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique source id of the Investor Account Contact to retrieve

Get My Coverage - Investor Account Contact¶

The get Investor Account Contact - My Coverage endpoint provides a way of accessing all Investor Account Contacts permissioned to the user.

Authorization

In order to access the Investor Account Contacts information, it is required to have the investor-account-contacts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Querystring	See Pagination	1
pageSize	integer	Querystring	See Pagination	250

Response

The endpoint returns a JSON payload containing a paginated array of the Investor Account Contacts permissioned to your user.

Create Investor Account Contact¶

The Create Investor Account Contact endpoint provides a way of creating a Investor Account Contact object in the CAS system.

Authorization

In order to access the Investor Account Contacts information, it is required to have the investor-account-contacts-write scope in the access token.

Parameters

This endpoint accepts a Investor Account Contact object as its body, as described in the schema.

Response

The endpoint returns a JSON payload containing the newly created Investor Account Contact Object.

Delete Investor Account Contact by ID¶

The Delete Investor Account Contact endpoint provides a way of deleting an Investor Account Contact object in the CAS system.

Authorization

In order to access the Investor Account Contact information, it is required to have the investor-account-contacts-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
id	UUID	URL path	The unique id of the Investor Account Contact to delete.

Delete Investor Account Contact by Source ID¶

This delete Investor Account Contact endpoint provides a way of deleting a specific Investor Account Contact object by source application id. It is for use when the CAS unique id is not known, such as when being invoked by a source application.

Authorization

In order to access the Investor Account Contact information, it is required to have the investor-account-contacts-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique Source id of the Investor Account Contact to delete.

Update Investor Account Contact¶

The Update Investor Account Contact endpoint provides a way of updating a specific Investor Account Contact object.

Authorization

In order to access the Investor Account Contacts information, it is required to have the investor-account-contacts-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a Investor Account Contact object to be updated.

Response

The endpoint returns a JSON payload containing the new, updated Investor Account Contact object.

Patch Investor Account Contact¶

The Patch Investor Account Contact endpoint provides a way of updating specific attributes of an Investor Account Contact object.

Authorization

In order to access the Investor Account Contacts information, it is required to have the investor-account-contacts-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a Json Patch body.

This endpoint sends a message to the common-investoraccountcontacts-topic Kafka Topic with the details of the Investor Account Contact that was patched

Patchable Attributes:

Type InvestorAccountId IsActive FirstName MiddleName LastName Email DetailData DetailData.PhoneNumber DetailData.JobDescription SourceId SourceRowVersion Types

Response

The endpoint returns a JSON payload containing the new, updated Investor Account Contact object.

Compliance Letter Request¶

Create Compliance Letter Request¶

The Create Compliance Letter Request endpoint provides a way of creating a Compliance Letter Request object in the CAS system.

Authorization

In order to create the Compliance Letter Request information, it is required to have the compliance-letter-request-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
id	UUID	URL path	The unique CAS id of the Investor Account
complianceType	Enum	URL path	An enum value from the list of ComplianceType.

Response

The endpoint returns an http response code indicating the success or failure of the action.

Schema¶

Example JSON

{
  "sentTo": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "status": "Requested",
  "dealId": "string",
  "dealSourceId": "string",
  "userId": "string",
  "userSourceId": "string"
}

ComplianceType¶

The type of compliance indicates the regulatory requirements that apply to the Investor. Valid values are status5131, statusQib and statusRegs.

Compliance Letter Request Object¶

sentTo: The list of investorAccountContactIds that the Letter Request will be sent to. These must be valid IDs that exist on the Investor Record.
status: The status of the letter request with possible values RequestReceived, Requested, and NotRequested. When the request is initially created, the service will change the status to Requested. When the destination system receives the request, the destination system will update the request the Request Received. A NULL value will be interpreted as NotRequested. Destination System will also set status back to Not Requested according to the client’s business rules.
dealId: The unique identifier of the Deal. This is sent when requesting the Compliance status to give details on the Deal.
dealSourceId: The identifier of the Deal from a source application. This is sent when requesting the Compliance status to give details on the Deal.
userId: Represents the User ID of the user sending the Letter Request.
userSourceId: Represents the User’s ID in the source application.

Investor Account Groups¶

Search Investor Account Group¶

The search Investor Account Group endpoint provides a way of accessing a collection of Investor Account Group objects based on the search fields.

Authorization

In order to access the Investor Account Groups information, it is required to have the investor-account-groups-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Investor Account Group Objects. The pagination is in the standard CAS format as described in Pagination.

Create Investor Account Group¶

The Create Investor Account Group endpoint provides a way of creating a Investor Account Group object in the CAS system.

Authorization

In order to access the Investor Account Groups information, it is required to have the investor-account-groups-write scope in the access token.

Parameters

This endpoint accepts a Investor Account Group object as its body, as displayed in the schema.

Response

The endpoint returns a JSON payload containing the newly created Investor Account Group Object.

Delete Investor Account from Group¶

The Delete Investor Account from Group endpoint provides a way of deleting an Investor Account - Group relation in the CAS system.

Authorization

In order to access the Investor Account Groups information, it is required to have the investor-account-groups-write and the investor-accounts-write scope in the access token.

Parameters

In order to delete an Investor Account in a group, you must pass a JSON body containing the group ID and the investor Account ID to the endpoint.

[
    {
        "groupId": "string",
        "investorAccountId": "string"
    }
]

Investor Accounts¶

Search Investor Account¶

The search Investor Account endpoint provides a way of accessing a collection of Investor Account objects based on the search fields.

Authorization

In order to access the Investor Accounts information, it is required to have the investor-accounts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Investor Account Objects. The pagination is in the standard CAS format as described in Pagination.

Get Investor Account by ID¶

The get Investor Account endpoint provides a way of accessing a specific Investor Account object by CAS id.

Authorization

In order to access the Investor Accounts information, it is required to have the investor-accounts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
id	UUID	URL path	The unique id of the Investor Account to retrieve

Get Investor Account by Source ID¶

This get Investor Account endpoint provides a way of retrieving a specific Investor Account object by source application id. It is for use when the CAS unique id is not known, such as when being invoked by a source application.

Authorization

In order to access the Investor Accounts information, it is required to have the investor-accounts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
sourceId	UUID	Querystring	The unique source id of the Investor Account to retrieve

Get My Coverage¶

The get Investor Account my coverage endpoint provides a way of accessing the coverage of your Investor Account.

Authorization

In order to access the Investor Account coverage information, it is required to have the coverage-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Querystring	See Pagination	1
pageSize	integer	Querystring	See Pagination	250

Response

The endpoint returns a JSON payload containing a paginated array of your Investor Account coverage.

Get Investor Account Coverage Search¶

The Get Investor Account Coverage Search endpoint provides a way of accessing coverage for Investor Accounts with the help of defined search fields.

Authorization

In order to access the Investor Accounts information, it is required to have the investor-accounts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
CompanyIds	array[integer]	Querystring	Values of the Company Id’s
UserIds	array[string]	Querystring	Values of the user Id’s

Response

The endpoint returns a paginated JSON payload containing the coverage for specified criteria.

Get User Coverage for Investor Account¶

The Get User Coverage for Investor Account endpoint provides a way of getting the coverage of an Investor Account object in the CAS system.

Authorization

In order to access the Investor Account information, it is required to have the investor-accounts-write scope in the access token.

Parameters

In order to get the coverage for an Investor Account, you must pass a JSON body containing the id’s of the Investor Accounts to the endpoint.

{
  "ids": [
    "string"
  ],
  "page": 0,
  "pageSize": 0
}

Response

The endpoint returns a JSON payload containing a paginated array of the Investor Accounts coverage.

Create Investor Account¶

The Create Investor Account endpoint provides a way of creating a Investor Account object in the CAS system.

Authorization

In order to access the Investor Accounts information, it is required to have the investor-accounts-write scope in the access token.

Parameters

This endpoint accepts a Investor Account object as its body, as displayed in the schema.

Response

The endpoint returns a JSON payload containing the newly created Investor Account Object.

Update Investor Account¶

The Update Investor Account endpoint provides a way of updating a specific Investor Account object.

Authorization

In order to access the Investor Accounts information, it is required to have the investor-accounts-write scope in the access token.

Parameters

The parameter that this endpoint accepts is a Investor Account object to be updated.

Update Investor Account by ID¶

The update Investor Account endpoint provides a way of updating an Investor Account object in the CAS system.

Authorization

In order to update the Investor Account, it is required to have the investor-accounts-write scope in the access token.

Parameters

Name	Type	Format	Description	Default
id	UUID	URL path	The unique CAS id of the Investor Account to retrieve

Parameters

The parameter that this endpoint accepts is a JSON patch body.

Response

The endpoint returns a 200 OK response when the item is properly updated.

User Groups¶

Search User Group¶

The search User Group endpoint provides a way of accessing a collection of User Group objects based on the search fields.

Authorization

In order to access the User Groups information, it is required to have the user-groups-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of User Group Objects. The pagination is in the standard CAS format as described in Pagination.

Get User from User Group¶

The get User Group endpoint provides a way of accessing a specific User Group object by userId.

Authorization

In order to access the Users information, it is required to have the user-groups-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
userId	UUID	URL path	The unique user id of the User Group to retrieve

Response

The endpoint returns a JSON payload containing a paginated array of User Group Objects the user is permissioned for. The pagination is in the standard CAS format as described in Pagination.

Create User Group¶

The Create User Group endpoint provides a way of creating a User Group object in the CAS system.

Authorization

In order to access the User Groups information, it is required to have the user-groups-write scope in the access token.

Parameters

This endpoint accepts a User Group object as its body.

Response

The endpoint returns a JSON payload containing the newly created User Group Object.

Delete User From Group¶

The Delete User from User Group endpoint provides a way of deleting a User object from a User Group in the CAS system.

Authorization

In order to access the User Groups information, it is required to have the user-groups-write scope in the access token.

Parameters

In order to delete a User in a group, you must pass a JSON body containing the group ID and the user ID to the endpoint.

[
    {
        "groupId": "string",
        "userId": "string"
    }
]

Investor Accounts Summary¶

Search Investor Accounts Summary¶

The Search Investor Accounts Summary endpoint provides a way of accessing a summary of Investor Account and Investor Account Contact objects based on the search fields.

Authorization

In order to access the Investor Accounts Summary information, it is required to have the investor-account-contacts-read and investor-accounts-read scope in the access token.

Parameters

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Form Data	See Pagination	1
pageSize	integer	Form Data	See Pagination	250
projection	string	Form Data	Filters a specific field to return in the response.	null
criteria	array[object]	Form Data	See Search Criteria	null
sortFields	array[object]	Form Data	Filters the search using specified criteria.	Private

Response

The endpoint returns a JSON payload containing a paginated array of Investor Accounts Summary Objects. The pagination is in the standard CAS format as described in Pagination.

Schema¶

The Coverage object structures are shown below, and underneath each JSON example, every element is described in detail.

Contacts Schema¶

Example JSON

{
    "isActive": true,
    "createdBy": "string",
    "createdDateTime": "2019-10-17T13:37:41.974Z",
    "organizationName": "string",
    "type": "internal",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "email": "string",
    "detailData": {
        "phoneNumber": "string",
        "jobDescription": "string"
    },
    "sourceId": "string",
    "sourceRowVersion": "string",
    "lastModifiedBy": "string",
    "lastModifiedDateTime": "2019-10-17T13:37:41.974Z",
    "types": [
        "internal"
    ]
}

isActive: Represents whether the contact is active or not.
createdBy: User ID who created the contact.
createdDateTime: Date-Time of when the contact was last last modified.
organizationName: Represents the contacts organization name.
type: Represents the contact type. Valid values are internal, syndicate, issuer or prospectus.
firstName: Represents the contacts first name.
middleName: Represents the contacts middle name.
lastName: Represents the contacts last name.
email: Represents the contacts email.
detailData.phoneNumber: Represents the contacts phone number.
detailData.jobDescription: Represents the contacts job description.
sourceId: Represents the contacts id in the source application, if exists.
sourceRowVersion: Represents the source row version. ?
lastModifiedBy: User ID who last modified the contact.
lastModifiedDateTime: Last modified date-time of the contact.
types: Represents the type of contact. Valid values are internal, syndicate, issuer or prospectus.

Groups Schema¶

Example JSON

{
    "companyId": 0,
    "isActive": true,
    "createdBy": "string",
    "createdDateTime": "2019-10-17T13:37:58.859Z",
    "lastModifiedBy": "string",
    "lastModifiedDateTime": "2019-10-17T13:37:58.859Z",
    "category": "investor",
    "code": "string",
    "name": "string",
    "sourceId": "string",
    "sourceRowVersion": "string",
    "metadata": {
      "subcategory": "representative"
    }
}

companyId: Represents the internal ID of the company associated with the group.
isActive: Represents whether the group is active or not.
createdBy: User ID who created the group.
createdDateTime: Date-Time of when the group was last last modified.
lastModifiedBy: User ID who last modified the group.
lastModifiedDateTime: Last modified date-time of the group.
category: Represents the category of the group. Valid values are investor or user.
code: Represents the code for the group.
name: Represents the name of the group
sourceId: Represents the groups id in the source application, if exists.
sourceRowVersion: Represents the source row version.
metadata.subcategory: Some firms divide their Sales Users into Rep Groups with differing responsibilities. The subcategory indicates the type of Rep Group. Valid values are representative or trader.

Investor Account Contact Schema¶

Example JSON

{
  "createdBy": "string",
  "createdDateTime": "2020-07-02T19:28:36.860Z",
  "isActive": true,
  "investorAccountId": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "detailData": {
        "phoneNumber": "string",
        "jobDescription": "string"
  },
  "sourceId": "string",
  "lastModifiedBy": "string",
  "lastModifiedDateTime": "2020-07-02T19:28:36.860Z",
  "sourceRowVersion": "string",
  "types": [
        "prospectus"
  ],
  "sectors": [
        "string"
  ],
  "roles": [
        "operationsCompliance"
  ]
}

createdBy

User ID who created the Investor Account Contact.

createdDateTime

Date-Time of when the Investor Account Contact was last last modified.

isActive

Represents whether the Investor Account Contact is active or not.

investorAccountId

Represents Contact associated with an Investor Account

firstName

Represents the Investor Account Contact first name.

middleName

Represents the Investor Account Contact middle name.

lastName

Represents the Investor Account Contact last name.

email

Represents the Investor Account Contact email.

detailData

phoneNumber: Represents the Investor Account Contact phone number.
jobDescription: Represents the Investor Account Contact job description.

sourceId

Represents the Investor Account Contact id in the source application, if exists.

lastModifiedBy

User ID who last modified the Investor Account Contact.

lastModifiedDateTime

Last modified date-time of the Investor Account Contact.

sourceRowVersion

Represents the source row version of the Investor Account Contact.

types

Represents the type of the Investor Account Contact. Valid value is prospectus

sectors

Represents the sectors associated with the Investor Account Contact.

roles

Represents the roles associated with the Investor Account Contact. Valid values are operationsCompliance, orderPlacer, portfolioManager, criticalContact

Investor Account Group Schema¶

Example JSON

{
    "groupId": "string",
    "investorAccountId": "string",
    "createdBy": "string",
    "createdDateTime": "2019-10-17T13:39:10.989Z",
    "lastModifiedBy": "string",
    "lastModifiedDateTime": "2019-10-17T13:39:10.989Z",
    "companyId": 0
}

groupId: Represents the group ID
investorAccountId: Represents the ID for the Investor Account.
createdBy: User ID who created the Investor Account Group.
createdDateTime: Date-Time of when the Investor Account Group was last last modified.
lastModifiedBy: User ID who last modified the Investor Account Group.
lastModifiedDateTime: Last modified date-time of the Investor Account Group.
companyId: Represents the internal ID of the company associated with the group.

Investor Account Schema¶

Example JSON

{
  "companyId": 0,
  "isActive": true,
  "createdBy": "string",
  "createdDateTime": "2020-08-20T19:40:04.287Z",
  "lastModifiedBy": "string",
  "lastModifiedDateTime": "2020-08-20T19:40:04.287Z",
  "code": "string",
  "name": "string",
  "type": "investor",
  "sourceId": "string",
  "data": {
        "pmid": "string",
        "orionId": "string",
        "isInvestorAccessEligible": true,
        "isCornerstoneInvestor": true,
        "entity": [
          {
                "codeType": "string",
                "codeValues": [
                  "string"
                ]
          }
        ],
        "identifications": [
          {
                "id": "string",
                "name": "string",
                "source": "lei"
          }
        ],
        "category": "agency",
        "country": "afg",
        "status5131": {
          "status": "restricted",
          "letterRequested": true,
          "expirationDate": "2020-08-20T19:40:04.287Z"
        },
        "statusQib": {
          "status": "nonQIB",
          "letterRequested": true,
          "expirationDate": "2020-08-20T19:40:04.287Z"
        },
        "statusRegs": {
          "status": "nonRegS",
          "letterRequested": true,
          "expirationDate": "2020-08-20T19:40:04.287Z"
        }
  },
  "sourceRowVersion": "string"
}

companyId: Represents the internal ID of the company associated with the Investor Account.
isActive: Represents whether the Investor Account is active or not.
createdBy: User ID who created the Investor Account.
createdDateTime: Date-Time of when the Investor Account was last last modified.
lastModifiedBy: User ID who last modified the Investor Account.
lastModifiedDateTime: Last modified date-time of the Investor Account.
code: Represents the code for the Investor Account.
name: Represents the name of the Investor Account.
type: Represents the type of Investor Account. Valid values are investor or subAccount.
sourceId: Represents the source application ID of the Investor Account.
data.pmid: Represents the PMID for this Investor Account.
data.orionId: The ID of the Investor Account in Orion.
data.isInvestorAccessEligible: Represents whether Investor Access is enabled for this Investor Account.
data.isCornerstoneInvestor: Represents whether the Investor Account is a “Cornerstone” Investor.
data.entity.codeType: Represents the entities code type.
data.entity.codeValues: Represents the entity code values.
data.identifications.id: Specifies the ID for the Identification.
data.identifications.name: Represents the name to search for in the Identification type.
data.identifications.source: Represents the identification type to use. Valid values are Lei or ClientLei.
data.category: Represents the category of the Investor Account. Valid values are agency or assetManagement or bank or bankTreasury or centralBank or corporate or foundationCharity or fundManager or hedgeFund or highNetWorth or insuranceCompany or moneyMarketFund or municipal or pensionFund or privateBank or retail or securities or sovereign or supranational or assetLiabilityManagement or brokerDealer or cooperativeBank or endowmentFund or financeCompany or fundamental or governmentAgency or holdingCompany or indexFund or individualInvestor or investmentAdvisor or longOnly or marketMaker or mediaPeriodicals or mutualFund or primeBroker or privateEquity or primaryWealthManagement or researchFirm or savingsBank or specialPurposeVehicle or syndicateBank or ventureCapital.
data.categories: Represents an array of global Investor Types associated to this Investor. Valid values are agency or assetManagement or bank or bankTreasury or centralBank or corporate or foundationCharity or fundManager or hedgeFund or highNetWorth or insuranceCompany or moneyMarketFund or municipal or pensionFund or privateBank or retail or securities or sovereign or supranational or assetLiabilityManagement or brokerDealer or cooperativeBank or endowmentFund or financeCompany or fundamental or governmentAgency or holdingCompany or indexFund or individualInvestor or investmentAdvisor or longOnly or marketMaker or mediaPeriodicals or mutualFund or primeBroker or privateEquity or primaryWealthManagement or researchFirm or savingsBank or specialPurposeVehicle or syndicateBank or ventureCapital.
data.clientcategory: Represents an array of a list of firm-specific Investor Types associated to this Investor.
data.country: Represents the three digit country code for the Investor Account.
data.status5131.status: Represents the 5131 Compliance Status of the Investor Account. Valid values are restricted or expired or partialRestricted or eligible
data.status5131.letterRequested: If a status is expired, restricted, nonQIB, or nonRegs, then the Sales User can ‘Request a Letter’ from the Investor, which kicks off the process to request that the Investor submit appropriate compliance information.
data.statusQib.status: Represents the Qib Status of the Investor Account. Valid values are nonQIB or partialQIB or QIB or expired
data.statusQib.letterRequested: If a status is expired, restricted, nonQIB, or nonRegs, then the Sales User can ‘Request a Letter’ from the Investor, which kicks off the process to request that the Investor submit appropriate compliance information.
data.statusRegs.status: Represents the Qib Status of the Investor Account. Valid values are nonRegS or partialRegS or regS
data.statusRegs.letterRequested: If a status is expired, restricted, nonQIB, or nonRegs, then the Sales User can ‘Request a Letter’ from the Investor, which kicks off the process to request that the Investor submit appropriate compliance information.
sourceRowVersion: Represents the source row version of the Investor Account.

User Group Schema¶

Example JSON

{
    "groupId": "string",
    "userId": "string",
    "createdBy": "string",
    "createdDateTime": "2019-10-17T13:40:02.430Z",
    "lastModifiedBy": "string",
    "lastModifiedDateTime": "2019-10-17T13:40:02.430Z",
    "companyId": 0
}

groupId: Represents the group ID for this User group.
userId: Represents the user ID for this User Group
createdBy: User ID who created the User Group.
createdDateTime: Date-Time of when the User Group was last last modified.
lastModifiedBy: User ID who last modified the User Group.
lastModifiedDateTime: Last modified date-time of the User Group.
companyId: Company ID associated with this User Group

Investor Accounts Summary Schema¶

Example JSON

{
    "investorAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "contactCount": 0
}

investorAccountId: Investor Account Id
contactCount: Number of Investor Account Contact found for Investor Account Id.