This route is used to retrieve the details of issuance closes given a set of search filters.
This endpoint is paginated, up to 500 records can be retrieved per call.
This endpoint can be called by applications with access to scope "readIssuanceClose".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The comma delimited list of statuses to filter the close records. Up to 3 entries can be provided. Available values: preSync, deleted, created
created,deletedThe start date from which the closes are to be retrieved.
The end date until which the closes are to be retrieved.
The comma delimited list of security ids to filter the close records. Up to 10 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of security correlation ids to filter the close records. Up to 10 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The comma delimited list of security ids to filter the close records. Up to 500 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01The comma delimited list of close correlation ids to filter the close records. Up to 50 records can be provided. Each record should not exceed 100 characters.
1234,5678,7890The 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.
The organization identifier linked to the correlation ids provided in the "closeCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
GET /external/v1/issuance-close HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"closeId": "US9QIMAOAS1Q",
"correlationData": [
{
"correlationId": "123245573717",
"origin": "Identifies a \"close\" on backoffice",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"extraData": {
"some": "Custom Property"
}
}
],
"securityId": "US9QIMAOAS1Q",
"status": "created",
"issueDate": "2024-09-12T00:00:00.000Z",
"priceData": [
{
"price": 10.23,
"asOfDate": "2024-09-12T00:00:00.000Z",
"bypassNAVCheck": true
}
],
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
}
}