NAV Navbar
Shell JSON

Authentication API

Authentication

login

Example Request

{
  "username": "davidjones",
  "password": "12345"
}
# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' -d '{
  "username": "davidjones",
  "password": "12345"
}' 'https://dev.heliocor.com/auth-api/api/authentication/login'

POST https://dev.heliocor.com/auth-api/api/authentication/login

Logs in a user

Logs in a user. Returns the person information and a JSON Web Token for secured calls.

Parameters

Parameter Type Required Description
username string true Username
password string true Password

Example Response (JSON)

{
  "identifier": "1b11320a682c418c9985af52321a05bf",
  "username": "davidjones",
  "name": "David",
  "organization": "Heliocor",
  "passwordExpired": true,
  "token": "string",
  "roles": [
    "AUTH:LOGIN",
    "DOKSTOR:USER"
  ]
}
{
  "identifier": "1b11320a682c418c9985af52321a05bf",
  "username": "davidjones",
  "name": "David",
  "organization": "Heliocor",
  "passwordExpired": true,
  "token": "string",
  "roles": [
    "AUTH:LOGIN",
    "DOKSTOR:USER"
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Persons API

Person

The Person Object

JSON Format

{
  "identifier": "string",
  "type": "string",
  "name": "string",
  "surname": "string",
  "gender": "string",
  "nationality": "string",
  "otherNationalities": [
    "string"
  ],
  "address": "string",
  "addressCity": "string",
  "addressState": "string",
  "addressZipCode": "string",
  "addressCountry": "string",
  "birthDate": "string",
  "email": "string",
  "phone": "string",
  "documentId": "string",
  "documentType": "string",
  "documentIssueDate": "string",
  "documentExpirationDate": "string",
  "aml": {
    "property1": "string",
    "property2": "string"
  },
  "status": "string",
  "statusidentity": "string",
  "statusaml": "string",
  "statusdocument": "string",
  "statusaddress": "string",
  "timestamp": "string",
  "documents": [
    {
      "identifier": "string",
      "type": "string",
      "status": "string",
      "timestamp": "string",
      "datas": [
        {
          "identifier": "string",
          "index": 0,
          "content": "string",
          "timestamp": "string"
        }
      ],
      "properties": [
        {
          "identifier": "string",
          "name": "string",
          "value": "string",
          "timestamp": "string"
        }
      ]
    }
  ],
  "action": "string",
  "actionDate": "string"
}
{
  "identifier": "string",
  "type": "string",
  "name": "string",
  "surname": "string",
  "gender": "string",
  "nationality": "string",
  "otherNationalities": [
    "string"
  ],
  "address": "string",
  "addressCity": "string",
  "addressState": "string",
  "addressZipCode": "string",
  "addressCountry": "string",
  "birthDate": "string",
  "email": "string",
  "phone": "string",
  "documentId": "string",
  "documentType": "string",
  "documentIssueDate": "string",
  "documentExpirationDate": "string",
  "aml": {
    "property1": "string",
    "property2": "string"
  },
  "status": "string",
  "statusidentity": "string",
  "statusaml": "string",
  "statusdocument": "string",
  "statusaddress": "string",
  "timestamp": "string",
  "documents": [
    {
      "identifier": "string",
      "type": "string",
      "status": "string",
      "timestamp": "string",
      "datas": [
        {
          "identifier": "string",
          "index": 0,
          "content": "string",
          "timestamp": "string"
        }
      ],
      "properties": [
        {
          "identifier": "string",
          "name": "string",
          "value": "string",
          "timestamp": "string"
        }
      ]
    }
  ],
  "action": "string",
  "actionDate": "string"
}

Properties

Name Type Description
identifier string Person unique identifier
type string Type of Person. Can be CANDIDATE or EMPLOYEE
name string Name
surname string Surname
gender string Gender. Can be MALE or FEMALE
nationality string Nationality
otherNationalities [string] Other nationalities
address string Address
addressCity string Address City
addressState string Address State
addressZipCode string Address Zip Code (Post Code)
addressCountry string Address Country
birthDate string Date of Birth
email string Email
phone string PhoneNumber
documentId string ID of the document
documentType string Type of document
documentIssueDate string Document issue date
documentExpirationDate string Document expiration date
aml object AML
status string Person Status
statusidentity string Identity Status
statusaml string AML Status
statusdocument string Dcument Status
statusaddress string Address Status
timestamp string Time it was created
documents [Document] List of Document objects
action string Last Audit event
actionDate string Last Audit event date

Add a Person

Example Request

# You can also use wget
curl -X POST
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "type": "CANDIDATE",
  "name": "David",
  "surname": "Jones",
  "gender": "FEMALE",
  "nationality": "British",
  "otherNationalities": [
    null
  ],
  "address": null,
  "addressCity": null,
  "addressState": null,
  "addressZipCode": null,
  "addressCountry": null,
  "birthDate": null,
  "email": "david@jones.com",
  "phone": null,
  "documentId": null,
  "documentType": null,
  "documentIssueDate": null,
  "documentExpirationDate": null
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person'
{
  "type": "CANDIDATE",
  "name": "David",
  "surname": "Jones",
  "gender": "FEMALE",
  "nationality": "British",
  "otherNationalities": [
    null
  ],
  "address": null,
  "addressCity": null,
  "addressState": null,
  "addressZipCode": null,
  "addressCountry": null,
  "birthDate": null,
  "email": "david@jones.com",
  "phone": null,
  "documentId": null,
  "documentType": null,
  "documentIssueDate": null,
  "documentExpirationDate": null
}

You need to send your token along with the request

POST https://dev.heliocor.com/dokstor-bo-api/api/person

Adds a person

Adds a person.

Parameters

Name Type Required Description
type string true The type of person. Can be CANDIDATE or EMPLOYEE
name string true Name
surname string true Surname
gender string true Gender. Can be MALE or FEMALE
nationality string true Nationality in 3 character ISO 3116-1 format
otherNationalities [string] false Other nationalities
address string false Address
addressCity string false Address City
addressState string false Address State
addressZipCode string false Address Zip Code (Post code)
addressCountry string false Address Country
birthDate string(date-time) false Date of birth
email string true Email
phone string false Phone number
documentId string false ID of the document
documentType string false Type of document. Can be NATIONAL_ID or PASSPORT
documentIssueDate string(date-time) false Document issue date
documentExpirationDate string(date-time) false Document expiration date

Example response (JSON)

{
  "person": {
    "identifier": "1b11320a682c418c9985af52321a05bf",
    "type": "CANDIDATE",
    "name": "David",
    "surname": "Jones",
    "gender": "Male",
    "nationality": "British",
    "otherNationalities": [
      null
    ],
    "address": null,
    "addressCity": null,
    "addressState": null,
    "addressZipCode": null,
    "addressCountry": null,
    "birthDate": null,
    "email": "string",
    "phone": null,
    "documentId": null,
    "documentType": null,
    "documentIssueDate": null,
    "documentExpirationDate": null,
    "aml": {
      "property1": "string",
      "property2": "string"
    },
    "status": "STATUS_PENDING",
    "statusidentity": null,
    "statusaml": null,
    "statusdocument": null,
    "statusaddress": null,
    "timestamp": "string",
    "documents": [
      {
        "identifier": "string",
        "type": "string",
        "status": "string",
        "timestamp": "string",
        "datas": [
          {
            "identifier": "string",
            "index": 0,
            "content": "string",
            "timestamp": "string"
          }
        ],
        "properties": [
          {
            "identifier": "string",
            "name": "string",
            "value": "string",
            "timestamp": "string"
          }
        ]
      }
    ],
    "action": "string",
    "actionDate": "string"
  }
}
{
  "person": {
    "identifier": "string",
    "type": "string",
    "name": "string",
    "surname": "string",
    "gender": "string",
    "nationality": "string",
    "otherNationalities": [
      "string"
    ],
    "address": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressZipCode": "string",
    "addressCountry": "string",
    "birthDate": "string",
    "email": "string",
    "phone": "string",
    "documentId": "string",
    "documentType": "string",
    "documentIssueDate": "string",
    "documentExpirationDate": "string",
    "aml": {
      "property1": "string",
      "property2": "string"
    },
    "status": "string",
    "statusidentity": "string",
    "statusaml": "string",
    "statusdocument": "string",
    "statusaddress": "string",
    "timestamp": "string",
    "documents": [
      {
        "identifier": "string",
        "type": "string",
        "status": "string",
        "timestamp": "string",
        "datas": [
          {
            "identifier": "string",
            "index": 0,
            "content": "string",
            "timestamp": "string"
          }
        ],
        "properties": [
          {
            "identifier": "string",
            "name": "string",
            "value": "string",
            "timestamp": "string"
          }
        ]
      }
    ],
    "action": "string",
    "actionDate": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get a Person

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 'http://localhost:8080/dokstor-bo-api/api/person/{personid}'

GET https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}

Returns a person information

Returns a person information.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

It returns a Person Object

Example response (JSON)

{
  "person": {
    "identifier": "string",
    "type": "string",
    "name": "string",
    "surname": "string",
    "gender": "string",
    "nationality": "string",
    "otherNationalities": [
      "string"
    ],
    "address": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressZipCode": "string",
    "addressCountry": "string",
    "birthDate": "string",
    "email": "string",
    "phone": "string",
    "documentId": "string",
    "documentType": "string",
    "documentIssueDate": "string",
    "documentExpirationDate": "string",
    "aml": {
      "property1": "string",
      "property2": "string"
    },
    "status": "string",
    "statusidentity": "string",
    "statusaml": "string",
    "statusdocument": "string",
    "statusaddress": "string",
    "timestamp": "string",
    "documents": [
      {
        "identifier": "string",
        "type": "string",
        "status": "string",
        "timestamp": "string",
        "datas": [
          {
            "identifier": "string",
            "index": 0,
            "content": "string",
            "timestamp": "string"
          }
        ],
        "properties": [
          {
            "identifier": "string",
            "name": "string",
            "value": "string",
            "timestamp": "string"
          }
        ]
      }
    ],
    "action": "string",
    "actionDate": "string"
  }
}
{
  "person": {
    "identifier": "string",
    "type": "string",
    "name": "string",
    "surname": "string",
    "gender": "string",
    "nationality": "string",
    "otherNationalities": [
      "string"
    ],
    "address": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressZipCode": "string",
    "addressCountry": "string",
    "birthDate": "string",
    "email": "string",
    "phone": "string",
    "documentId": "string",
    "documentType": "string",
    "documentIssueDate": "string",
    "documentExpirationDate": "string",
    "aml": {
      "property1": "string",
      "property2": "string"
    },
    "status": "string",
    "statusidentity": "string",
    "statusaml": "string",
    "statusdocument": "string",
    "statusaddress": "string",
    "timestamp": "string",
    "documents": [
      {
        "identifier": "string",
        "type": "string",
        "status": "string",
        "timestamp": "string",
        "datas": [
          {
            "identifier": "string",
            "index": 0,
            "content": "string",
            "timestamp": "string"
          }
        ],
        "properties": [
          {
            "identifier": "string",
            "name": "string",
            "value": "string",
            "timestamp": "string"
          }
        ]
      }
    ],
    "action": "string",
    "actionDate": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update a Person

Example Request

# You can also use wget
curl -X POST
--header 'Content-Type: application/json'
--header 'Accept: application/json'
--header 'Authorization: Bearer TOKEN' -d '{
  "name": "string",
  "surname": "string",
  "gender": "string",
  "nationality": "string",
  "otherNationalities": [
    "string"
  ],
  "address": "string",
  "addressCity": "string",
  "addressState": "string",
  "addressZipCode": "string",
  "addressCountry": "string",
  "birthDate": "2018-09-10T13:56:26.113Z",
  "email": "string",
  "phone": "string",
  "documentId": "string",
  "documentType": "string",
  "documentIssueDate": "2018-09-10T13:56:26.113Z",
  "documentExpirationDate": "2018-09-10T13:56:26.113Z"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}'
{
  "name": "string",
  "surname": "string",
  "gender": "string",
  "nationality": "string",
  "otherNationalities": [
    "string"
  ],
  "address": "string",
  "addressCity": "string",
  "addressState": "string",
  "addressZipCode": "string",
  "addressCountry": "string",
  "birthDate": "2018-09-10T13:56:26.113Z",
  "email": "string",
  "phone": "string",
  "documentId": "string",
  "documentType": "string",
  "documentIssueDate": "2018-09-10T13:56:26.113Z",
  "documentExpirationDate": "2018-09-10T13:56:26.113Z"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}

Updates a person

Updates a person.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

JSON Parameters

Name Type Required Description
name string true Name
surname string true Surname
gender string true Gender. Can be MALE or FEMALE
nationality string true Nationality in 3 character ISO 3116-1 format
otherNationalities [string] false Other nationalities
address string false Address
addressCity string false Address City
addressState string false Address State
addressZipCode string false Address Zip Code (Post code)
addressCountry string false Address Country
birthDate string(date-time) false Date of birth
email string true Email
phone string false Phone number
documentId string false ID of the document
documentType string false Type of document. Can be NATIONAL_ID or PASSPORT
documentIssueDate string(date-time) false Document issue date
documentExpirationDate string(date-time) false Document expiration date

Example response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Person Type

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "type": "string",
  "message": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/type'
{
  "type": "string",
  "message": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/type

Updates a person type

Updates a person type.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

Parameters

Parameter Type Required Description
type string true Type of Person. Can be CANDIDATE or EMPLOYEE
message string false Message

Example response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete a Person

Example Request

# You can also use wget
curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}'

DELETE https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}

Deletes a person

Deletes a person.

Parameters

Parameter Type Required Description
personid string true Person identifier

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get all Persons

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person'

GET https://dev.heliocor.com/dokstor-bo-api/api/person

Returns the list of persons

Returns the list of persons.

URL Parameters

Parameter Type Required Description
type string false Type
first integer(int32) false First person [0, -]
max integer(int32) false Max persons [1-100]

Enumerated Values

Parameter Value
type CANDIDATE
type EMPLOYEE

It returns list of Person Objects, along with the count of all persons and persons by status.

Example Response (JSON)

{
  "count": 0,
  "countPending": 0,
  "countReview": 0,
  "countApproved": 0,
  "countRejected": 0,
  "countCancelled": 0,
  "persons": [
    {
      "identifier": "string",
      "type": "string",
      "name": "string",
      "surname": "string",
      "gender": "string",
      "nationality": "string",
      "otherNationalities": [
        "string"
      ],
      "address": "string",
      "addressCity": "string",
      "addressState": "string",
      "addressZipCode": "string",
      "addressCountry": "string",
      "birthDate": "string",
      "email": "string",
      "phone": "string",
      "documentId": "string",
      "documentType": "string",
      "documentIssueDate": "string",
      "documentExpirationDate": "string",
      "aml": {
        "property1": "string",
        "property2": "string"
      },
      "status": "string",
      "statusidentity": "string",
      "statusaml": "string",
      "statusdocument": "string",
      "statusaddress": "string",
      "timestamp": "string",
      "documents": [
        {
          "identifier": "string",
          "type": "string",
          "status": "string",
          "timestamp": "string",
          "datas": [
            {
              "identifier": "string",
              "index": 0,
              "content": "string",
              "timestamp": "string"
            }
          ],
          "properties": [
            {
              "identifier": "string",
              "name": "string",
              "value": "string",
              "timestamp": "string"
            }
          ]
        }
      ],
      "action": "string",
      "actionDate": "string"
    }
  ]
}
{
  "count": 0,
  "countPending": 0,
  "countReview": 0,
  "countApproved": 0,
  "countRejected": 0,
  "countCancelled": 0,
  "persons": [
    {
      "identifier": "string",
      "type": "string",
      "name": "string",
      "surname": "string",
      "gender": "string",
      "nationality": "string",
      "otherNationalities": [
        "string"
      ],
      "address": "string",
      "addressCity": "string",
      "addressState": "string",
      "addressZipCode": "string",
      "addressCountry": "string",
      "birthDate": "string",
      "email": "string",
      "phone": "string",
      "documentId": "string",
      "documentType": "string",
      "documentIssueDate": "string",
      "documentExpirationDate": "string",
      "aml": {
        "property1": "string",
        "property2": "string"
      },
      "status": "string",
      "statusidentity": "string",
      "statusaml": "string",
      "statusdocument": "string",
      "statusaddress": "string",
      "timestamp": "string",
      "documents": [
        {
          "identifier": "string",
          "type": "string",
          "status": "string",
          "timestamp": "string",
          "datas": [
            {
              "identifier": "string",
              "index": 0,
              "content": "string",
              "timestamp": "string"
            }
          ],
          "properties": [
            {
              "identifier": "string",
              "name": "string",
              "value": "string",
              "timestamp": "string"
            }
          ]
        }
      ],
      "action": "string",
      "actionDate": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Documents

The Document Object

JSON Format

{
  "identifier": "string",
  "type": "string",
  "status": "string",
  "timestamp": "string",
  "datas": [
    {
      "identifier": "string",
      "index": 0,
      "content": "string",
      "timestamp": "string"
    }
  ],
  "properties": [
    {
      "identifier": "string",
      "name": "string",
      "value": "string",
      "timestamp": "string"
    }
  ]
}
{
  "identifier": "string",
  "type": "string",
  "status": "string",
  "timestamp": "string",
  "datas": [
    {
      "identifier": "string",
      "index": 0,
      "content": "string",
      "timestamp": "string"
    }
  ],
  "properties": [
    {
      "identifier": "string",
      "name": "string",
      "value": "string",
      "timestamp": "string"
    }
  ]
}

Properties

Name Type Description
identifier string Document unique identifier
type string Document type
status string Document status
timestamp string Time it was created
datas [DocumentData] DocumentData Object
properties [DocumentProperty] ocumentPropery Object

The DocumentData Object

JSON Format

{
  "identifier": "string",
  "index": 0,
  "content": "string",
  "timestamp": "string"
}
{
  "identifier": "string",
  "index": 0,
  "content": "string",
  "timestamp": "string"
}

Properties

Name Type Description
identifier string DocumentData unique identifier
index integer(int32) Number of the document scan
content string DocumentData content
timestamp string Time it was created

The DocumentProperty Object

JSON Format

{
  "identifier": "string",
  "name": "string",
  "value": "string",
  "timestamp": "string"
}
{
  "identifier": "string",
  "name": "string",
  "value": "string",
  "timestamp": "string"
}

Properties

Name Type Description
identifier string DocumentProperty unique identifier
name string DocumentProperty name
value string DocumentProperty value
timestamp string Time it was created

Add a Document

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document

Adds a person document

Adds a person document.

Example Request

{
  "type": "string"
}
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "type": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document'

URL Parameters

Parameter Type Required Description
personid string true Person identifier

JSON Parameters

Parameter Type Required Description
type string true Document type

Example Response (JSON)

{
  "document": {
    "identifier": "string",
    "type": "string",
    "status": "string",
    "timestamp": "string",
    "datas": [
      {
        "identifier": "string",
        "index": 0,
        "content": "string",
        "timestamp": "string"
      }
    ],
    "properties": [
      {
        "identifier": "string",
        "name": "string",
        "value": "string",
        "timestamp": "string"
      }
    ]
  }
}
{
  "document": {
    "identifier": "string",
    "type": "string",
    "status": "string",
    "timestamp": "string",
    "datas": [
      {
        "identifier": "string",
        "index": 0,
        "content": "string",
        "timestamp": "string"
      }
    ],
    "properties": [
      {
        "identifier": "string",
        "name": "string",
        "value": "string",
        "timestamp": "string"
      }
    ]
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get a Document

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid} '

GET https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}

Returns a person document

Returns a person document, including data and properties.

URL Parameters

Parameter Type Required Description
personid string true Person identifier
documentid string true Document identifier

Example Response (JSON)

{
  "document": {
    "identifier": "string",
    "type": "string",
    "status": "string",
    "timestamp": "string",
    "datas": [
      {
        "identifier": "string",
        "index": 0,
        "content": "string",
        "timestamp": "string"
      }
    ],
    "properties": [
      {
        "identifier": "string",
        "name": "string",
        "value": "string",
        "timestamp": "string"
      }
    ]
  }
}
{
  "document": {
    "identifier": "string",
    "type": "string",
    "status": "string",
    "timestamp": "string",
    "datas": [
      {
        "identifier": "string",
        "index": 0,
        "content": "string",
        "timestamp": "string"
      }
    ],
    "properties": [
      {
        "identifier": "string",
        "name": "string",
        "value": "string",
        "timestamp": "string"
      }
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get all Documents of Person

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document'

GET https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document

Returns the list of person documents

Returns the list of person document.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

Example Response (JSON)

{
  "documents": [
    {
      "identifier": "string",
      "type": "string",
      "status": "string",
      "timestamp": "string",
      "datas": [
        {
          "identifier": "string",
          "index": 0,
          "content": "string",
          "timestamp": "string"
        }
      ],
      "properties": [
        {
          "identifier": "string",
          "name": "string",
          "value": "string",
          "timestamp": "string"
        }
      ]
    }
  ]
}
{
  "documents": [
    {
      "identifier": "string",
      "type": "string",
      "status": "string",
      "timestamp": "string",
      "datas": [
        {
          "identifier": "string",
          "index": 0,
          "content": "string",
          "timestamp": "string"
        }
      ],
      "properties": [
        {
          "identifier": "string",
          "name": "string",
          "value": "string",
          "timestamp": "string"
        }
      ]
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete a Document

Example Request

# You can also use wget
curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}'

DELETE https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}

Deletes a person document

Deletes a person document.

URL Parameters

Parameter Type Required Description
personid string true Person identifier
documentid string true Document identifier

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Add Document Data

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "index": 0,
  "content": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data'
{
  "index": 0,
  "content": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data

Adds a person document binary data

Adds a person document binary data.

Body parameter

URL Parameters

Parameter Type Required Description
personid string true Person identifier
documentid string true Document identifier

Parameters

Parameter Type Required Description
index integer(int32) true Number of the document scan
content string true Document binary content

Example Response (JSON)

{
  "data": {
    "identifier": "string",
    "index": 0,
    "content": "string",
    "timestamp": "string"
  }
}
{
  "data": {
    "identifier": "string",
    "index": 0,
    "content": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get a Document Data

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data/{documentdataid}'

GET https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data/{documentdataid}

Returns a person document binary data

Returns a person document binary data (content is returned).

URL Parameters

Parameter Type Required Description
personid string true Person identifier
documentid string true Document identifier
documentdataid string true Document data identifier

Example Response (JSON)

{
  "data": {
    "identifier": "string",
    "index": 0,
    "content": "string",
    "timestamp": "string"
  }
}
{
  "data": {
    "identifier": "string",
    "index": 0,
    "content": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get all Data from Document

Example Request

curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data'

GET https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data

Returns a person document binary datas

Returns a person document binary datas (content is returned).

Parameters

Parameter Type Required Description
personid string true Person identifier
documentid string true Document identifier

Example Response (JSON)

{
  "datas": [
    {
      "identifier": "string",
      "index": 0,
      "content": "string",
      "timestamp": "string"
    }
  ]
}
{
  "datas": [
    {
      "identifier": "string",
      "index": 0,
      "content": "string",
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Document Data

Example Request

# You can also use wget
curl -X POST
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "index": 0,
  "content": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data/{documentdataid}'
{
  "index": 0,
  "content": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data/{documentdataid}

Updates a person document binary data

Updates a person document binary data.

URL Parameters

Parameter Type Required Description
personid string true Person identifier
documentid string true Document identifier
documentdataid string true Document data identifier

Parameters

Name Type Required Description
index integer(int32) false Number of the document scan
content string false Document image in binary data (base 64)

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete Document Data

Example Request

# You can also use wget
curl -X DELETE --header 'Accept: application/json' --header 'Authorization: Bearer TOKEN' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data/{documentdataid}'

DELETE https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data/{documentdataid}

Deletes a person document binary data

Deletes a person document binary data.

URL Parameters

Parameter Type Required Description
personid string true Person identifier
documentid string true Document identifier
documentdataid string true Document data identifier

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete all Data from Document

Example Request

# You can also use wget
curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data'

DELETE https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/data

Deletes a person document binary datas

Deletes a person document binary datas.

URL Parameters

Parameter In Type Required Description
personid path string true Person identifier
documentid path string true Document identifier

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Document Properties

Example Request

# You can also use wget
curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer TOKEN' -d '{
  "properties": {}
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/property'
{
  "properties": {
    "property1": "string",
    "property2": "string"
  }
}

PUT https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/property

Updates a person document properties

Updates a person document properties.

URL Parameters

Parameter Type Required Description
personid string true Person identifier
documentid string true Document identifier

Parameters

Parameter Type Required Description
properties Array of key:value true Payload of properties

Parameters

Parameter Type Required Description
properties Array of key:value true Properties payload

For the properties array the key will be the name of the property and the value will be the value of it.

Example Response (JSON)

{
  "properties": [
    {
      "identifier": "string",
      "name": "string",
      "value": "string",
      "timestamp": "string"
    }
  ]
}
{
  "properties": [
    {
      "identifier": "string",
      "name": "string",
      "value": "string",
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete a Document Property

Example Request

# You can also use wget
curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/property/{documentpropertyid}'

DELETE https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/property/{documentpropertyid}

Deletes a person document property

Deletes a person document property.

URL Parameters

Parameter In Type Required Description
personid path string true Person identifier
documentid path string true Document identifier
documentpropertyid path string true Document data property

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete all Document Properties

Example Request

# You can also use wget
curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/property'

DELETE https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/property

Deletes a person document properties

Deletes a person document properties.

URL Parameters

Parameter In Type Required Description
personid path string true Person identifier
documentid path string true Document identifier

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

AML

Get AML Hits

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/hit'

GET https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/hit

Returns the list of person AML hits

Returns the list of person AML hits.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

Example response (JSON)

{
  "hits": [
    {
      "identifier": "string",
      "type": "string",
      "name": "string",
      "surname": "string",
      "gender": "string",
      "nationality": "string",
      "birthDate": "string",
      "title": "string",
      "risk": "string",
      "matchName": "string",
      "matchType": "string",
      "score": "string",
      "lastUpdate": "string",
      "active": "string",
      "status": "string",
      "timestamp": "string"
    }
  ]
}
{
  "hits": [
    {
      "identifier": "string",
      "type": "string",
      "name": "string",
      "surname": "string",
      "gender": "string",
      "nationality": "string",
      "birthDate": "string",
      "title": "string",
      "risk": "string",
      "matchName": "string",
      "matchType": "string",
      "score": "string",
      "lastUpdate": "string",
      "active": "string",
      "status": "string",
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Lookup AML Hits

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/hit/lookup'

GET https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/hit/lookup

Lookups and returns the list of person AML hits

Lookups and returns the list of person AML hits.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

Example response (JSON)

{
  "hits": [
    {
      "identifier": "string",
      "type": "string",
      "name": "string",
      "surname": "string",
      "gender": "string",
      "nationality": "string",
      "birthDate": "string",
      "title": "string",
      "risk": "string",
      "matchName": "string",
      "matchType": "string",
      "score": "string",
      "lastUpdate": "string",
      "active": "string",
      "status": "string",
      "timestamp": "string"
    }
  ]
}
{
  "hits": [
    {
      "identifier": "string",
      "type": "string",
      "name": "string",
      "surname": "string",
      "gender": "string",
      "nationality": "string",
      "birthDate": "string",
      "title": "string",
      "risk": "string",
      "matchName": "string",
      "matchType": "string",
      "score": "string",
      "lastUpdate": "string",
      "active": "string",
      "status": "string",
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete AML Hit

Code samples

# You can also use wget
curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/hit/{hitid}'

DELETE https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/hit/{hitid}

Deletes a person AML hit

Deletes a person AML hit.

URL Parameters

Parameter Type Required Description
personid string true Person identifier
hitid string true Hit identifier

Example response (JSON)

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Audits

Add a Person Audit Event

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "type": "string",
  "message": "string",
  "payload": {}
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/audit'
{
  "type": "string",
  "message": "string",
  "payload": {}
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/audit

Adds a person audit event

Adds a person audit event.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

Parameters

Name Required Required Description
type string false Type of Audit Event (see list below)
message string false Audit message
payload Array of key:value false Audit payload

For the payload array the key will be the name of the property and the value will be the value of it.

Audit Types

Audit Type
ADD
UPDATE
TYPE_UPDATE
STATUS_UPDATE
STATUS_IDENTITY_UPDATE
STATUS_AML_UPDATE
STATUS_DOCUMENT_UPDATE
STATUS_ADDRESS_UPDATE
DELETE
DOCUMENT_ADD
DOCUMENT_STATUS_UPDATE
DOCUMENT_DELETE
DOCUMENT_DATA_ADD
DOCUMENT_DATA_UPDATE
DOCUMENT_DATA_DELETE
DOCUMENT_DATA_DELETE_ALL
DOCUMENT_PROPERTY_UPDATE_ALL
DOCUMENT_PROPERTY_DELETE_ALL
DOCUMENT_PROPERTY_DELETE
REQUEST_ADD_OR_UPDATE
REQUEST_DELETE
REQUEST_ACCEPT
REQUEST_REJECT
REQUEST_CANCEL

Example Response (JSON)

{
  "audit": {
    "identifier": "string",
    "type": "string",
    "message": "string",
    "payload": {},
    "timestamp": "string"
  }
}
{
  "audit": {
    "identifier": "string",
    "type": "string",
    "message": "string",
    "payload": {},
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get all Person Audits

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/audit?first=0&max=50'

GET https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/audit

Returns the list of person audit events

Returns the list of person audit events, sorted by timestamp.

URL Parameters

Parameter Type Required Description
personid string true Person identifier
first integer(int32) false First audit event [0, -]
max integer(int32) false Max audit events [1-100]

Example Response (JSON)

{
  "count": 0,
  "audits": [
    {
      "identifier": "string",
      "type": "string",
      "message": "string",
      "payload": {
        "property1": "string",
        "property2": "string"
      },
      "timestamp": "string"
    }
  ]
}
{
  "count": 0,
  "audits": [
    {
      "identifier": "string",
      "type": "string",
      "message": "string",
      "payload": {
        "property1": "string",
        "property2": "string"
      },
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Requests

Add or Update Request

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "types": [
    "string"
  ]
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/request'
{
  "types": [
    "string"
  ]
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/request

Adds or updates the request

Adds or updates the request

URL Parameters

Parameter Type Required Description
personid string true Person identifier

Parameters

Parameter Type Required Description
types [string] false Request Type

Example response (JSON)

{
  "request": {
    "identifier": "string",
    "types": [
      "string"
    ],
    "status": "string",
    "timestamp": "string"
  }
}
{
  "request": {
    "identifier": "string",
    "types": [
      "string"
    ],
    "status": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get Request

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/request'

GET https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/request

Returns the request

Returns the request or nothing if there is no request

URL Parameters

Parameter In Type Required Description
personid path string true Person identifier

Example response (JSON)

{
  "request": {
    "identifier": "string",
    "types": [
      "string"
    ],
    "status": "string",
    "timestamp": "string"
  }
}
{
  "request": {
    "identifier": "string",
    "types": [
      "string"
    ],
    "status": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete a Request

Example Request

# You can also use wget
curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/request'

DELETE https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/request

Deletes the request

Deletes the request.

URL Parameters

Parameter In Type Required Description
personid path string true Person identifier

Example response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Status

Update Document Status

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "status": "string",
  "message": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/status'
{
  "status": "string",
  "message": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/document/{documentid}/status

Updates a person document status

Updates a person document status.

URL Parameters

Parameter Type Required Description
personid string true Person identifier
documentid string true Document identifier

Parameters

Parameter Type Required Description
status string true Status Types, see table below
message string false Message

Status Types

Status Name
REVIEW
VALID_AUTO
VALID_MANUAL
INVALID
EXPIRED

Example response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Person Hit Status

Eample Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "status": "string",
  "message": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/hit/{hitid}/status'
{
  "status": "string",
  "message": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/hit/{hitid}/status

Updates a person AML hit status

Updates a person AML hit status.

URL Parameters

Parameter Type Required Description
personid string true Person identifier
hitid string true Hit identifier

Parameters

Parameter Type Required Description
status string true Status Types, see table below
message string false Message

Status Types

Status Name
REVIEW
MATCH
CLEAR_AUTO
CLEAR_MANUAL

Example responses(JSON)

{}
{}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Person Status

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "status": "string",
  "message": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/status'
{
  "status": "string",
  "message": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/status

Updates a person status

Updates a person status.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

Parameters

Parameter Type Required Description
status string true Status Types, see table below
message string false Message

Status Types

Status Name
PENDING
REVIEW
APPROVED
REJECTED
CANCELLED

Example response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Person Address Status

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "message": "string",
  "statusaddress": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/statusaddress'
{
  "message": "string",
  "statusaddress": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/statusaddress

Updates a person address status

Updates a person address status.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

Parameters

Parameter Type Required Description
message string true Message
statusaddress string true Status Types, see table below

Status Types

Status Name
REVIEW

Example response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Person Status AML

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "message": "string",
  "statusaml": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/statusaml'
{
  "message": "string",
  "statusaml": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/statusaml

Updates a person AML status

Updates a person AML status.

URL Parameters

Parameter Type Required Description
personid string true Person identifier

Parameters

Parameter Type Required Description
message string false Message
statusaml string true Status Types, see table below

Status Types

Status Name
REVIEW
MATCH
CLEAR_AUTO
CLEAR_MANUAL

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Person Document Status

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "message": "string",
  "statusdocument": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/statusdocument'
{
  "message": "string",
  "statusdocument": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/statusdocument

Updates a person document status

Updates a person document status.

URL Parameters

Parameter In Type Required Description
personid path string true Person identifier

Parameters

Parameter Type Required Description
message string false Meessage
statusdocument string true Status Types, see table below

Status Types

Status Name
REVIEW
VALID_AUTO
VALID_MANUAL
INVALID
EXPIRED

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Person Identity Status

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "message": "string",
  "statusidentity": "string"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/statusidentity'
{
  "message": "string",
  "statusidentity": "string"
}

POST https://dev.heliocor.com/dokstor-bo-api/api/person/{personid}/statusidentity

Updates a person identity status

Updates a person identity status.

Parameters

Parameter Type Required Description
personid string true Person identifier

URL Parameters

Parameter Type Required Description
message string false Message
statusidentity string false Status Types, see table below

Status Types

Status Name
REVIEW
INVALID
CLEAR_AUTO
CLEAR_MANUAL

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Job API

Minimal KYC Sample

Minimal KYC Sample

Example Request

In order to perform the minimal KYC job, you need to attach the following images in .jpg or png format: passport or idcard, selfie and utility bill with address details.

In the following example we will use the following:

Passport :

Selfie

Utility Bill


Job

Add a Job

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "name": "John",
  "surname": "Doe",
  "gender": "MALE",
  "nationality": "GBR",
  "address": "77 Main Street",
  "addressCity": "London",
  "addressState": "London",
  "addressZipCode": "W1",
  "addressCountry": "UK",
  "birthDate": "1990-12-10",
  "email": "john4@doe.com",
  "phone": "+447022222222",
  "documentId": null,
  "documentType": "PASSPORT",
  "documentIssueDate": null,
  "documentExpirationDate": null,
  "callback": null,
  "expiration": null,
  "documents": [
    {
      "type": "PASSPORT",
      "datas": [
        {
          "index": 0,
          "content": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTEhMWFRUXGBoaFxgYGRgYHhsaGBgYGhoeGBoYHSgiGBolGx4aIjIhJSkrLi4uGyAzODMsNygtLisBCgoKDg0OGxAQGy8lHx8vLy0tLS0tLS0tLi0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLf/AABEIALsBDQMBIgACEQEDEQH/xAAbAAACAwEBAQAAAAAAAAAAAAAEBQIDBgEAB//EAEQQAAIBAwIEAwUEBwcDAwUAAAECEQMSIQAxBAUiQRNRYQYycYGRI0JSoRQVscHR4fAHM2JygpLSFlPxJDRDF0RjorL/xAAZAQADAQEBAAAAAAAAAAAAAAAAAQIDBAX/xAAkEQACAgICAgICAwAAAAAAAAAAAQIREiEDMUFRBBMiYTJx8P/aAAwDAQACEQMRAD8AK547rTklpyfecAE+UGBv28tLeQUapqIDUqwZMeI4BIkwRdttjvPrrUe2aJ4TT+Hf/MRvOQSPz1V7McJcatcqZAtUBScAqQIAxMRPaJ763pNGd+RvxXG3KpdDgAzkGMb2kA/T+Szi+YhtktCjEMwJAyZg7/1jR/EVVtDkgJ2JhR8MxntoEUEJiYB90EEFgfKdx66qEYJO2RJNiapx1MkEiGqDpZrjMqpiScEgggYO8d9Ro8dSpoTa5FrOT1npT3iBPYxpvW5WkAWSuIElgCLSsSTtapB9BrtTk6LTh6RAsK2m7KMZO5mPX+er+zJKKJuOTTQrbj1apkkE25F0G++yIMGbX9MeomjiuYI6ELNq1AjAE4ctYAYPmfoQdo0zp8EobxGQ5PvG45F0ESe1zfU6u/UqDqWmJkGboyGLq3vZ6yWHqdN/g7YJRjFiblnMREAk3A4zdj3tzKxIwfMRvOutx4vC5uYsqCD1FWCmM9iRvp9+pUcEGmhkQwLLkW256sqVgEH0Hloapw9JWgICZljmQSbultwbsyO+pUvsegai4i5ub03IvJ95BswnxGtjB3kQfLHmNWcz5utJTSCwAxmLouVfEIAJybTPlg99Mk5VSaIRSOxjaCjfKCiH4qD5HUeacAkl2QFHGDGD0qpnyaBB7x6acUm6ZTSSM+3F9SkRJBYQBsCBM/EjvnQtXjgSTubrT0j3urE7T0nG+34hLmpRQm4rd2GO0g/MSB9B5DURwlPBsPn04zn1kmGb/cddFEKhceOKnztZFIt/Hhd/M4mex8tGnmK0i6EMOi9lAMFYcyRMfcft2jvmFXhqQYQu5EyCNiWH0bM6cpwNCqLqlMMSoBJ7gKwH5M4/1N5nWPMl2XChA3HqJa3ADNcFAwGKkgiO43GDgg65U4wBjcBdKAgqpINQ2rMjOcfLT3juUUhlU94MD5EE3Hv3Yk/H46GfgKbZKS289/euHf8AFnXmzlFSaPU4oucUwKnzIPTZvuoMiwSN8WxIbHlmViZGpJzRKdMrdEAthZBUAm4R74A3HaVxkSXQopBFse787fdnzj+GpUOCpWhfDDAXAIZOCLMROLcR8NPiksqZn8rj/DL0epcWEpqWNgvKMbYKvmQTsg8jtkZzqVTmVIdTfiK3GcsrhGzPZyBnG/Yac0uGpsgVqeDdcpyDeCGuk9UgmZnfXX5dRMzT3M997lYkQcEsFJjcjOuu4nnaE45jTtBhrbFfIaAtQkKc7Se/7iNdp85owbcABiYByqF1cwPfAKN5+fcacDltC0KKcLYFABIhVYlQADgBtvKY21AcsoZBpGGm4XNm5mZp6u7Mx+Z0JxBoWUeZ0iyAQGckJgiSDBCsMFtzg7BiJtMdrc0phyrDqDWZDHq+zx5n+8T6+hhpT4CivSKfSCGjJFysHDAEwDeLp889zIPMqXDK0vQdmJvJBO/QLgbsHoTIiLRppphpAXH8ctRAFki8j70St1w7hSACf/IlZV4xUMggQ1hxgORIDdu4ycT66cHieGkRRqQCc3MILB7iIfchm+p1RxHA0VOFuV1xkwwNwhlmCYZtxmfTW8K6FaF/C8eGMAZMmIt2tmIgiJGx76eLx98XIq+pBMx6zPpk/wAdLeC8FQCqw0b5O4WYk4m1foNFfpansdEuOD7KToUj2srU1fxKBo0g0XVQVUkzAU2EtIBPoBkjTHlnOazeJS/RKlHobrINrQbYRgoBOQRBzGPVTwXs/SSozI1ZbzLCKbKeq4Sr02UwcgkGO2nnIvZuhQrmujVzUqBlc1O9zKxMhQSZAO/8uecIpGidmRo06ivIZzn8RIMEgiQdaWl4tPtM/iW76Xfu0Jx/CijxFrTZUggxEG8fvx/q1szSEmQ3yVfpkbDb66c4WlTHGdPaKPa/hvEanT3BK9u14Ijy7YyPro+pwJWnaikEusQCIwI+AHn6aI5vRniKQAwGTHYRJ0XxXCCocs6246WiZCnPnrklyVIErRmfaukQ1MSSCCAMklgYJI+EZ+Ok4q1KAg5otBKAwYJkxPuz3G2c603G8pWKh8Q9CloMHsTnP56z9PlrvWDKYRjDE9pUkz54B+Y1vxNNUyZL0OuH4tCgqL1qWG2IzPV+EjaO/bGia7E5nyIP8PTWUZa1KtFJSWiCoUsGWT7wHvLrVcPTc0rjSKkfcMGPOIMle8GCM7zq2oxiqIT220L61NwzMqgqCLVjJwpPyi8DzMdgZq4k1iDCAkXQfPBK7+uPQnEjaNDxhksWuBDbdxgjzIIB+Z8te4s10iGmYOPw2sO/mYPmMzcIlPKToSlCSdngaySbQWG2NlIGf82SIjGTrlThXJBtwVXAGzmZG52j89R4UV23eTnePxKf9XQG/rOiODNVLQ7SQeqDi2wYOMktv+7YL8uOQNQUQqjw3hqVOboJj08vh+eo83oBaQUkAz1CcywEGBsIAyfP10etMGGG3l5enw/r4Ae0Ff7AugB8MNk+gBXy6d+4/goyuVs0pVaM4rRi4GPKD+Q1OyPvDJ2kT9N5/Zpty/ljFbnRVMtgATEkAkBjGO0nf5aOXk6g5G/e0/GZ+J10/aiMTPpSBtB3J2PwO3Y+WNH8AFC2uwEbT5E/x/bpn+rAMGCJkgkeUdxn56gKRpG4yVIIkZiDImPi2dZ8vImqCq2C1+FlTaZ7gj+XbfQZoCTc0fkPOJOJjPz014OqVYgSymSFAkwdtzCrO07+Wl3NOJZKqg0qcMCTcLsKyKYKiR7wMnAg64eWDk7R1/H+RGMaZRTCgQCM/E7Ab+W/fV/J2TxSLlJtMZ8mMx/W2lrcc/UfDQQUIUUrsTVBAUSzRZuI3OMZa8v4G62oi2mA2IEFpJCuBDjybMg6XHxNO2Vz/JU4YoceGfL1+PlqtnVTDMBOROMfHbRXCowUBt/4nGe51JqCthgCO8j9v563OJAS1U/Gv1Hof3jXH4hMS652zgjIMHbcf1OlFSvVWjUfwqa1abC9TTBCoRMkrVNwCksSOoiRbnJVarUNV6Ypoy+H4lH7OSxDC4L9oBIuAyUy47A6AoLNanLKWAI3kx5dzjvq0umZdJ/zD+Px+mkg500JfSpsnh+JUgNC1LKptBb3WlAuQd2yIAayvxhS8GlRLUld2IUgMEp0mtAuwxFWJJIxt5MKGnEpSZbWKwYG/fffsdA1OWqkGxSu4cAfn/HbXqnMWEr4KOXJFFFXMiq6m+4gNAW/Ee6wGROnnCOlWkrJmnUUEYiVcTt2MHbTCvIp4PggUSLRKj9np/WNFJwJ2xPxGvcLwjAW72dO8TAEflGrkpvkAfH/AM9xOsXaNVTVlFSmFFzMoEgZI3YgLnzJxojh6yPaA6FuvZgfcNrfRjB9dV8fTYIstaDUpj3iszUURIBmfI77d50VUax/EY20lQgksYm5fuxnyme0RnQMU855enEkopBKgzaRhgwkHyMHTzhqKgC4wYWZgds75OdD8JSYVnvG4Yr1XdNwjsLR6Zjz1oKYxrdSpUSkKuKSeLp+hP5If46q5l7RcPSJUuSw3CgkyO04H56We1/GtSqh1a0gNHUVJ6VHTAILZ2bHx1i+EdalxqPBOZgmSZJnE6XFwxnJuZMptKka2lQWtVqcRX+zovTAW5gsggDJBxtt66U8xQSBTe5QeljifI/HJ/PVPHUzUZSKlMBVVB1CQqgDb4ydF84rU3tp0k6VVVBuXtPxGtnHa/1C/RHhi6EVLhIEHtI/ZP7dbDlPHeJcStqz0kznzkazFLgFpUxUq3kdltMn8ureJ29dA849oakWovhj1wf5a5ZJ9s01ejV8XQpliRHqJwTOJH1+MR5xxuFWosFhd2z5/wAdYVOaVXKS7zPUbmFyxiY7zq3ifaCtTIVHLPtaeoAesnp22301PGqObkmk8a7Ntyrl2LiO+Nux3+R12tyqGJ7eQ1L2Y9oFrixyBUA22nztByRrQmmD8dZvnlJ2Vx4yWhLw/BWjbcR8v6/rOvcTwjWwi3GdpjB37jTenTDd86D51wLNRqKsFivTJgTuJPYTidJSZ04pLQCqVR/8MjsC4+f5D11O2tiKI7Gb8euBEY/PSzheUVhXFZ1BUkk07py1evUVsYZqaupjIJJjKqdMPajhWeioRQxVrhLQJtcAsI6hJGxBHvAyo1d6EWq9bvSAwfvg5AwI+ON/XVFfmFlytBbIAUiclomTjpAM+sdtZnjuGZvHYe87MLenINRH6rsOYXAbABI7nRvI+SrejmmKiCmqi4qDScGoX6Vw14NPbyM7DSpeQdvSCuEdQAtwLEZgySe+e51bW4dWi9FaDIuAaCNjnY+us9zvkVTwaUIaK0/0glUK7u6tTm0xECJ7RHfU6HKqpDkAoWrmqr9AlRVqVEkqb2WCkhhtjbV6ZlVaHlHhKaklaaLJuJCqCWzkx3yc750VSpgAAAAAQAAAABgADy0Hyqky0KS1BDimgcTdDBRcJ7wcT30cjZ00Mo42qVwPy+Olq8WwMgzv/R034ujcPXQFPl5kSRH7dMC6nwFFkUeDTtBvC2LAY/eAiJ9d9TbllFr5o02vi/pXrIMi4xkzET30QEjbH7tWR5j+egAT9XUpVhSp3KtqGxcLEQuMLBIj1Oq05PQAVTTS1WuUWqAreaqAM7Z0wUjznz1ZHy0wAW5VQIcGjTIqG55ReogzL46jMnPnq+tUsUBRJOFUY+WNgB+Q1fHz0NxHDtd4ikSAMETtuAfuz56CWc4RIW5mktBJMDt+Q1EVQ5w6gduoXH1icY+OvZcIhRlAtLz5LGx9T5eWjP0dCIKr5xA1Cg3tminXQDx9UwopMSS6A2y+CwBmGEYJ6u2+dtFnh2CEI0N2JkgZzgEHb10NzPhKJCX+Gv2iQWUGTdIA2hidj21RVRqIuqOl0BBXKjpBcEKwnY7AzvGhw9Apew3hnDVm6WEKR1CJh4kTup7HTk42GkfDcOiVmCKFuBYgd2ZiST66dk5zpjXkyPtMyfpCVGUGxgVLNaisQLS/YiRgEgT3Gs9y6vw1wDqtRSimowNrq3UWgArcdyQASIA6tHe1bywYkQKkZm26xil0fduCzOMaTl2vUmVYuthAcPbMMOmG9ybgmNrd9Rk07RJuKPslwrgFbiDsQ5Ij0PfRZ5LQ4RTVAIsBMyx7ZiTGfhon2aINIREBmA+uZPxuPzEwZGl3t/xltJaY3c/kuf2xpqc3qUmy8UtpGE5xzypUe6TP3RPuz+zQL8DWquJYsBnfHaf3alwdDMkd9aHg1Gq5OZ1RUOKzNNy51kj6TtqKUmg200nzEz885+G2tg1CRtOgzwFrTMfn/R1zudjlwpqmZqhxDUnDKSrAzPkdbn2W9sndxS4iJPuuBAI9e3zxrHcy4aV+ck/EaF4dmp2tPusI+E4I1XZg+HF6PuD4Nw0LzNldGuNqqCzHGwBk5+vyGhuRcV4lJTPpqfM2TwnWoCUYFWjyIMz6RpdG3gT0eY0bqXXXBdVZVYiM1fDtbMBw0ys7K0TB1Tx3H0zSDA8QQ7BUl6S3SjVAwLVBapVWwxBztkauocPwOFUEKrqyBQwAZajOLABgXOwjaGjbVfDcJwYwj1FghlK9rVemqiVyIdgLgTtnA1fgloUVKIFxbxD4ZII7yBmI+XzjWh5VwINEOKlQBwGADdmEj550NU/RmvDtUIqEM9JgCv3DkAbEAAiYImJ0Xw3HcPSprTpkhFkKoUiBOyyBAEwPhHbUtpldCHmvMEsRvtrb3BRyrR4XS7YLCFY2nJz2xphynjFqXqoYWMyybdw7AgAMWEEEdQHppZV4Wgwpor1HpUgQGJEm60FCYEpCAnvJydNuA4JaZcqzG5mYg2wCzMxghQ27HBJjWiMnthrGDHlryj89RJ31NAN/TTsKJhvy10j89dbz10f19BqgIKdAcyr2m3yP89H6o4/hA+diBpBQu4eoVIg6e0zMaA4bl0e8Z0wTtphRInXVGuRqS50wo8B310Dtrw2/ryGvKNMALmTwKcGJqoPeKz1bYUzgbGAfMaq4rjVaizgoaJTpeTJYtaBbbtdGZ37d9FcfUZfDtnNRQYUHpIMzJFo9RJ9DqPNmbwytNodiqiROCerEj7gbP8NCYNA/JA97X5JEiWu6SzFcwIx27bSdPa7520n5W4NRoUqAoUTAPSzCcE4MSPQ6b8R72o8lIwnO1BosGBYNWKYs3NNyILe7JAEjOdL/AGN5dSqcRVRqZRqYypWIJKsYFQXLZIUEgE7nfDLnaj9EyrOTXKoVawq5RgjhgcBTB1jqK1qPi0hxI8Q1E6UhxUZqfvitUYCWMC098x06yfY4o+u8BaoSnTAVVEATtAgA+cDvrI+23H3cSw3FMBR8Tk/PI132brsEYg4Z2IJKmZVZMp0yXuJtwDIE7lDxPHG6oGgq7EkESD2HwPkdHDuzXlVUS4AifTTik6eY0kooBk4X1P7dD1uMRjaEz2iM/CN9OUGwjNRNlRbp0PxA30u5PxRAIYbDH7dKeZ8WDLEEx27b76yUPBpKVKwjmBFpEzGkyHYecg/u1dT4wVBaEtIAjYSPiNC1Hg5wQf3a0Soxk72fUvYuRwyz8PzOmvN3ZKFRkMMFkGJj1iD+w/DSj2HcNw4zsWn6z+/Trj3tQsHC2yWZiAAAMkkg41L7FWjOcPzLii1EmSt8ObQQVNcoDimC0rAuUJE3EWzq2pxzGg7+OccUULBKbQhrCmMeGf8A4yGmJzORjTHh+LqMt/iUWVpCkEwWutAnzmRG86T86upujPXQsSBY57kn3FjAA2O5g76qO2JnOYe0BniBRq3sPCslOmnd7xYhJj1a4DeIB0EnHcRVqUlqy1IinPSEyyViblAM5VchoxgZ1dR5qTcfFpKUAJDMBggmSBkbjviNs6tXmLlQUKvkdaglDNsSfOT28xq6/RPZPjqtjUlBFNGJBNoPVKwg8rpbb8OhjxrkcXbV6qVSEgIxAFNGg4z1lln/AAxuDo+rVqXQr0dyuSZuABKx3MZ+GoLxT9X2lHo97qm0yR1fh8s+X0VhRTX46yq6NXgJw95whOC0vG5IA22yND8HzRi3DA1kiorFiDTALBwLQY6okr0RJE6au9ULczU1AklhgWgqZltjF3pt8dW0uYUzZFWmTUHRDqb43tz1D4eWmOhf7MczqVlPigBlSmTAIBNS9pE7gpZ8DcO2HU/z1B6oUSTAHfUqbggEEEHY7/npsVFo9PlryjOMmfqdcQ6mB/4H7vXQh0eTtqfy1yNdUTphR4TqQ12NeE6YUexro1EajxHELTEtPoBkk+g0xUUce1MlAzAFGV8qGHcDJEITnO+l1wYUqqvkFAeIKBfEyQqgRsSzdoEk6lSDPWWED9ZNSS6sqQRDWta65ELBBiYmNNqTqpFQSKVRKS0xFWQSWAmkRFMdS9UD/FEDRLQVZRy7h0SrUVFCjpMAAZYszGB3Jkn46a1QJ0n5RRZHqB9+mepm3LEZbJwf6GnbrnadSMx/Hsg4Jb5tasDhS+xukqGWQLZyTtsdJuD5MHqFlYQS2VlyV8RiACwiJGDGBAzuNJxHACtwdOm2B75ZsAWsSJIIjHf4+mkJNRKXg0KlNnZwKbo4W+laWFjEwDJCmDnOuaabNOOSg22rNAnLLKWBaEQwN8AeffbXzatThSfnr6bXL0uCKu1zimQT5kjOfKT+Wvm3MfdK/Afv1pxxqIpScm2w3lJDgA/snTD9TKOq6WHb+GdI+UEqYOQPhrSLxC4Kz8+3lnWcpOLN4QUog1JbWNo7fH/xpfSpB7gRPnq3iPENRmQjz1HgUZWa8gyIxpt6tAo+GcHBBMgaz3MX6yPnrRcfxEDWWrZqH+vXRC3tk8yS0jef2c8T79P0uH7/ANo1s+Z0r6TJcEJiGOwIIIkSJExidfM/YqrbxSjzUj8p/dr6XzNgKTswuCqWiYm0E79ttN9mQuflbCpTqNXCstV3KC20+IzEgXC6602z5FsCTrvtLyg8QgVWVCCbmInpNKpTPxi+flqzlXDUqtFKlltwm2agxOMVFRgfio+e+iKfK6S7LBgiZPcQfy0raYCPgPZ0xVN1NyzBleSYKsjAFIhR0wSDMHTjiQpospVXdVuanTNslRMDMiTjPnonhaK05AEZ0t40o1ZqfhXWoKtRrisB/ECQB7+aTTkRjeTDtvYUZ2hyms/hKFtUBiWqzAd3SozJAwTUUwDMXDJ738NwVS2qh8O4Vr1BdirE1WqgRb0qQwggttMYjRHB85pGneOHOC9RockW01os7qWAuIvQWwMq2YEmrjwrmqadBhVp1FpGXwzscLnDDw2R5x/eKJBBjTKyRrxdHxKDU1KyyW493yjvA3E5j4jWfp8FY9P7RJpsSQGqORNZqhB6f/UMbol4KkltzqFTjL0vFK5ABlHYMSaI4nw1DAQWpsOrYExpxw9ei4I4embjGckKrGSTJgHBwczpjonUL1HtNymQQpxYvZmge+TMKTjvpnRphFCjtnOc7mfM6A4fktMSTLkkGSSDgDy32GdFLy2mIFgEep7GR3027HQUjqTAMnykT9NWgfP+vy+OhqHDKCWAyZn10SBnz9PP00go7qSb65qRH89NBRye2pTqJ15lkEZGNx2+GrFRB6qqJZgo7k4+WdJ3p3VLaLgsbmJFpI8xcAWbE4EY1YeXVFyCrwDBa45xsrSAx2mYEnGiOH5q1MLclxjd08KNulWAIxHePy1aVdBQ94virGprGajlZuQQbGaYYgvtEKCczEA6pPC1QBNctApzKIJtm8nGLxv5RjVHEc1pMAbKjRkMtMm0wRKkjJicidK+D45agBFfit6I6kGctEwkC8zce0dtYtMKCuU8T4ju8RNmJVtpG6kg/I6dzpNwQAqVAogSmBiMHy04jTJYragG4RQSFFqtJEgFYcSO4kCR3E6+d8dXhqaUmqUwAFuLZvaqXJuEGYZoDhSOrGdfUFT7JV/wqP8A9dfOec8rYH9Hq1FdrQKQVVQlnL2AtBJFwJIkDbqGsED7G9Xj1NHiLRVaiXIRz1ACAuC7XspecqCM6wtdibh3x+zT/hF4e1GpszSekVEqIoYgghqrLZapOWBJxgE75qq8k/MGMiVOYPfbVp6BEeUPErMZn66dJVMY31mVUhwV/oY044bi/PGpmrNuOVKi+nxFQkxaPnqvxql2YPz0dQpI24k/DUOMRVEgQNQmatgXEuTvpXwqXVWP9eWvcz4+BCjJMTq7l9OPp9daJUjCTtjv2ST/ANWnxI/I6+l8eegi2+cFc5BkHYH9nfWD9k+DIrBz32+sa3vHZpv0s/S3SphmxspkQTtMjUtiKafGnP2NQADuPLA+f11OpzC0LNGoZE4ExmIPrGdZqlwPEX8ObagC5YTgFqxLKZeVREIgw14wQsab+04qtTQ0hUZg8kUzbMK8BzepCloyJgxIKzorYWX1uMa4W0qgE5JHYZ2g75GY7aG4hg01Dw7l0Q2yDmZFuN9z5wC0b6B4qlXL8RHiAl0s/vQoTxKd0EVLYtn3FUwGydV8DQI4cPWquVKl6guJBElhN0thYG+YzPeoxGtgFEeIP7tgZUsBTAINoQZDHFiKCGBkBJHkXXoswZWFU+IyuwZFMuqqoJKlSAAijEbD11T4VVVoFQ8s9zquFF7KbWIOLFJAkFSFYGCVOorRrtet1QMaxkk1lHhzWt6r4iLP7uPuzq/6CwyC1x/RVDWBZJdViLfcAywHTgTECY0XyjhbTUaxELsWKqTFxLXtJA95s/8AnUOB4R1qAs7tFNASSbWfqDEJNoJAU/PVvGU2NWgylrQ5DKD0wadTLDv1BRnz0DGF2hV41sfZPmZwcDMZPcjt22+IPs5TdabK5c9XS7h1ZxaJJSozFcyOwO4A7i8yTimesqM6oxIRlm4TRpZHa0PfH+IHQA5HHnfw3A7YjMeWrhxZ28J5nsCe/T8zjHY6Qcu4XjLlFSqZV7nbIU/aBmRFiGW2UExAg76t5JzGomK61j0ozFwJDhftrciUByLZG8SI068AtjqnxrZmkwx3G+QP3k/LRHCVSwkqVIOx+AP8vlqD8bTAzUQf6h3276IpVAcggjzGqoDo10Tqt3AEkgfHGrVYHIII8xpgcqeY1ykTqurXVPeYL8SB5bTqqnVqPLUQhQd3JW8/4D5DzIg7aaQUV8yqJfTJZSablrQGZz0MIUKcGSNwcfUS4HiyKcNSqrc8gFDgVSSJjAjv5SNeFTwFo02UXVCQ7XAG4qzMRg3mRt2nUH5ccHxXYCzezNkzPT96c/lGspzXSEQ5NRsZ0kEgrtdGZP3iT9TrQ6zvIa/iM7QokoYUhhtGCAJ+mtA2qIl2Z720DHhQEKhg6EXMUncQGGzRJHqNJU9oQKKs0VOLWkq22sCan2kAkbXZMbgSO2iP7SnP6CADH2iTBjENO2vnFPhAotVVJjqMDfy9P36yqyUzS0+TpxIpGnULhCxqU6jJRIaqxPRCsE61Y2kEwRrN8x5X4b0xDR4QqSYlr52gmEHaYbGRopH6IBIAPugYODvkWjJ28yMa5xPEs+WMm23JY4GwFxMD00xrsX0gQRdvj4fId9M1Ram2DE4MjtvtH9RqVHgVa0+NTWT94wBnMxJmM7air0lVkDyxdQZUwVBgb4iMwT2jUspMpZnQSrdJ+evUVqP7xkHf+jppUFJAQ9WlAiIJbvj3Qcd5wB5ydQRaWOGp1B4j1EULDnFQiTfbaAJJ8/LcSFZezNcebXVbTEj6TGmXCVlvtuEjJH8NMv8ApuqHZWALKbXMOQCVBXKqRJBUAg9x5Egd/ZmmjGo9SmtQCShLkgghcgC0HYROraM1LZtfZRCyhowMCdaPj16GIJEZ6QScdgFIJPw0h5bxyUqdAZFNkZmcg9JUhRKgGZYx5yR6wxocxo10ZKHEC4oTckXICWUMAwwQwIyNxnWdFWBcPzVLkU1qhaoWUA0yIZXKEHOCGUjHlMgGdE8fVNILdXYXdIARnubqYmEBIAG52AXVSezqhqTeI58IKBhMhHZxBtlCSYYrF4HVOhvaCh+kstFWZVpvc7rb71htC7kMLpu7eumopvQJWC8x5oGLItdyikeJUVKnvFwoSnYOskkDpJwfTRfA0iVVkqkoVhQVjEECQcgjyPln0U1eBoIzIXlXqKzdAwVqK0O4AlZxHYN20fV4yKdnDKsxCki2mvYZ2PkFE61xNFFnjxSgqorkXMVUWFuqmQlQyJwHIEkgAkCdQq8cgUt4z2qbSfCqZIuwuOv3SJEjG41TwXBColCKlpp5MQWMMMz7yEhc5zewMmIhV5OgZKTlStSsXIiyffNrEElib4G22liFMIoca9dhTos1wS8lwyAqYggqpUgwczHltphWNRGVGqqGYgLFFyhJJgPUzaTBAyPz0z4fhQrlhAFiIFAAACFyIj/PHyGheM4e6vSqGpApgkU7LgWbF0zhokD0Leepy9E2Bcu54jqHZXW6Csq8OMQaciWGR276F4nioACV2mQCCpBHTaxgxJETbvmdNOV8vp0lIJkmoKnSnhqrAKvQq+6CBnJkk6ZP4bixhcD2IMGM9++Py1Sa9FJ+0KOC4HiHUN+kJBnqVCZEQDBIAznz7aF4zga6t9pULQwsqERTWTuVUzvjP7NaTxKaFEkKWkIoxNoLEKPQZ1KrXpw1zpABukrAA3uk+XnpZ7FkI+T8vLs2YsMXIJVpi6DOG2xkfnorh/ZhlJmuxU5gArsIAIDZA+Pp66PpcfQWotBSAxW5VVTEZjqAtBMMQCZIUkTB0wBAzq8n4E2KuG9nFXZhPYlATMiT1Ezj9up1fZ4FmZXKFjIsFtuRGxhhEiCMzpuH1XWrQCZ7anJiFCchZSWauXJIyyKTA2G8DOZjOiTQciDUJiRMREzGAYIAP5DV9ev8fln+s6GVz56UpWJuzjLFO1iWOY8++3eY0rox0/8Auf8A4sNd5GLvT8fy0bxPD3vTbp6GLZUMTKlekz0nO/y1WaZR2cLd4lim1VBEXdTMTlc/L56gCfLz9rV8pT/+dO51m+SUPDd0xgpsto90nABxrQvrVDl2Y/8AtGX/ANEoP/cp/SDr53SqljcCAx3GBkftyNfZOecjTiaS0qhYKGVumBkAxvPnpA/9nHD9qtX52nfywNZZpGWLPnq1BgYxudx8BqJI9Pz3+mt//wDTuj/3qn0XVZ/s8pf9+p9F0s0PFmBLA/Cd/TVTOucbnH5emt/U/s+pbCvUHyXVdT+zylH9/U+i6M4jp+j5xxBnGN87CdUtxBpMGpsVIaQ3cMDKmdfSR/ZxS/79Sf8AKuqKv9m1I/8A3FT/AGpoU4hTM1y+jV8GrzCvWTiAAQKT1HYXsAimosRes4QiNjIga0HsrxjfotOoy0vDcrRenbLOymw1V2BcmLkAyFLTcLTyp/ZrSA/9xVIJWRCZEgeWmY9j6dKnbRqVVIUgFSt5nJUOyk0lJibLfXTzT8jpmdre0Nam4Vek8LWFPwqTmpTqpZUYjrALOKliknaQcQ0VcHzAcPwtJKVVfHuDVHDp0h6gd0RT7wICqS0LiRrWcJ7J0EUDqAt90EATuetVDnPecwPTS6h7C0sE1ajDcKwRgsjYMylgJ7TnHfOi4j2B1vbuvUB+xK0Q1tR6bS0H7qsem74HIPbXh7Q0C4tY0FBAUm09nvimjEuSSvY7ZjTH/omnaE/Sa9oBhfs7c+S2gD5fnrnD+w9BQssS8dTQATvsVgqO28+erUkkUpNIA/60SnNKmilQWJfiGQG4sSSy0yxbtiAcD4C/gPa3iovrcN4lE4uRbZ8oV2OPrtvpnT9lKQz4lQwIEsTHkQWJOPLQ1T2JpPl6rsfMhLvk9t3yMj01LaZLtkR7RcJVDjw2pVQJUhIa7zB6czvJjfOp8t5+R4lU8PUqNhQZoqAANsVGKkme0T31On7IpaEPEVmSZKt4ZUnfIK4yZxGqW9g+HwQ7Kw+8BSB+hUhT/lA0ZaoeUqoqT2+a+G4cQNwrMXXfMMq3Y8hHqN9Sre2JanUtpOrMsU32EybTFrD5AtsR66J/6LpEQ9arUA926yVP+FlUMO2JjG2vJ7HUZjxavSBBuHeZ7T5fQd86NC2KV9rOLtE1UAZiZKG6CMABQ6wDsMHzO+m/Ae2iSq8QHVgZustkWtJiSD/pn66r4z2SZUtoVKjAnKVGRlUR90sCZJjz9TGu0vYrhwqAhlDGSnSQDaSRlTO0Xbnz01QU0P14OnXqpxK1r7IFO0yoHUHkAwS0xnItHrqjjfZtapYNVYC4ugCrKsaqVjJM3jxFUwRtIzo3guFSktlMBR8Nz5kzJProgMfMfT+elaChZ7QcuqVOum4kAqAKZuh1KMA6up8PN5XeVww7DUPZ6qg/947ZYy4YnqCjP2kNEESQcNtIDB31/iH+0/8ALVdjn7w/2n/loyChOOUcSrLbx1RltIqBw0ktALKVYWdOABFpyJyC5V2Wla7FiFPUdzvE+ZiJPcye+ueA/wCID/Sf+Wurwz/jX/Yf+Wpch0WF5z/X5a8p1wcM/wCNf9h/56mnCP8AjX/Yf+ejQmjtw0Px9RgoKkjrQGAGwWAO5Hbv23AOiP0R/wAa/wC0/wDLXqnAFhDFGAIMFDuDIPvbg50UCAORuxeoXm6UmVCnY9gTGPXWhbS/hOXlXdy4N5XAUiLRHmZ01NH11qmOXZCufd1GvWVRLMANsmM/PXq77H10m57yz9J8IE2qrlmICkwaVRMB1YfeHbadcsuxLoaE/TVFTiF/EAJjcb+Xx9NLjy8iutRXJVUsVW6rIUgNTM4Y7NIJI7jYoTyOuKKoVpdFRSApVZVaD0ibjROSxBhg5AnJxqaQ7Naa6g23C45iRMfDVYqqcyO0Z89vrrOcJyN1q8PULKRSp00I/wAlOqhZSVuwWAAJAIJmCBqg8jrPS8NmWmQKSKyMzStG/qIKrF10FAdphsyHS9js1IqA5GR6ag1dQCSwAG+Rj4+WlP6vYvQqEqvhrBpCWpjBE0/dtcbBiD0yIEzpeOTVCK6mxFqVabi0hjCV/EYy1PuMhWvAM5gwFS9hY+4qsIGRkqQJAmGBxJzrh4jfpON8pjvnqxjShuUlKlA0wGSmrA3MoPU6NMeGQdjhbO0QNreH4R18eadI33FWuN1S5nYLVlOkLcFGW+A21SSCw5uLxgHIx1Jnbbq22+uoU6ygAFgCqiRIxA7+WkPHezxq06AYKrUaVoCkxd0QJtEpKhtt1XVnE8qZjxQKqVrKwBLb3KohhZIGD949seVpIVj3xB5+fr/R17xNIKfKHsCtUkrVZoglaiTCCqsgsbYJz72dtEtwbCs9VWDEoQoce6YEBGHuoSJYQZMGcRopAMjXX8Qg+u8b/sOumuNgRJEjaY8/hrLvyB/BWkrJNN3akxkZam3vCO9RnkA+6floujy6otcPKlDliYu/uVphQLJADLcCHHvuCux06QDylxKtswOYwQc/x9NWeL2nO8emNZvgOX1qdBEtQujq0F8MFUA9QpCO+IPx0S/BVW4inXJVbVClcn3g5qQ0DF3h9s2TjToB09cKJLAD1Mft1AspIM77QSJA8s5xpG/LKi0atNCtRqjTdUkMVJAa5oaWCzaQoA6RGJM6vLmNSm4WmAFpDck0/CZmIp9PUGBsJ6cKDnYADlChmGkjeGJj4wdWhBvnHmSfTudIeB5Y9lamxNO92ZXpsLoao7/9sFcETJbvkaITlR+wNyg0gBYFIpmCOpUulXEdJkxPffQOx4H9dTu0lXlRmv8AauPGGHGKiTOEfawT0i3GcmdS/U5soC9R4TTaE+zfrDSyXf3giQ0mGJMHbU0gHgGug6VUuWnxKzeK0VVgH79PAEU32CfeAjDSZMwIfqY+FTp3rNNy0BISpkn7VLpZsyTd73VHbQFjoamDpX+rT41Sp4hN6Fc5anNv90/3VxJEEloM4jQr8iPgCl4g6WLe6basg44hbpqTPVBEkT6aVBZoQdSVtKf0E+P418grba2bNs0iDCT96QZxkRBFHIz4DUfFOXuvIy+BjiII8YGMwVkQMRJBGinUp0m/Vx8anWuEIseGRKr0sLqMEeGxmCTdK4EZm7k/AGl4kv4lzXXN759HaYaO0BYECMSaGN1OjQdLbo0yJ1cRSFfESYnaf46A5zzVaChmBNzBRBRc2sctUZVAhe58ho/jNl+P7tA8w4XxEsvZAfettllIIKywMAzuIONxrGf8tiXRRU5qFrrw9j3spYNNO2FiZF9wyYm2J+ulze0qeDVrmlUtpOUYXUSZUdUEVbTDdMTN2ADpg/LlNRKhZiKf92nTapsKSOm49JIgsRnbaBhyzDAVqlzkFqn2VxgQFjw7Yj/DPrqVQzlTnKCtToFXD1FDD3cSGMe9Ji0yVBAxnI1TT56rKSKVSfsyi9EutUkIy9cAYJ6iCANvOwcnpqyMpYBFRQkiD4QIQkkXSATsRPedVU+ToogPUB6LTKygpElAvTECTuDMmZ00lQWzp52sp0VIbw7j0QhquaaB+qZLgr0gxvMa5U57RCVnBuFAw8FNxg7npAMgloHS2YE68OToChueFCSJEOabl0L4mQ5LYIk76qbk1OGFz5tjI6LKniKFxsHz1TOxxjTpAXUecI60yqufEFwgA2rIEsQSIk4gmRkYBOqRz6n9p732YYthc2NaY6sZ/FE76jV5JTIQXN0G77puN/idUrA689MRJAgGNcHJKcuSWa8OINsAVHvYCFzLAe9Mdu+mkgOcR7QU1FMkN9qxQe6IZWCEZbqN2wWSQCRIGupzhGrPRhrqa3McEQLewJYHqESouzExqutyWmVVQXUKHUAEe47KxTIwotUCIIAGdWUuXqtU1QWk3QCRAvILEYnJA3JA7Rp6AhU5uBSFbw3tkhh0SsEg3AsJyIgEkzgamvMB4hQqwEkBzbaWChiB1XbHuIwdVVuXKQgDMtjM4ItPU5Yn3lI7mO489SPL1vZjJDT0E9MsoViBEyVEbxk+enSA5W5sopo4Vmv91RYD7rPm5gB0g4nU6XMkaoKYBJKLUnEWtdbgkNPSdh5ap/VFLw2pW9DNcVOQcgxmentA7aKHDqHNT7xVV7YCFyIxj3j+WgAOpztQjOyMtjhGUmkCCQGEtfYMEEywP5aJPMh4ipY2bQW6bQXBKg9UyY3AIyM6q4XltlLwlqVLfPoBA7iQg3ySd5JzqQ5aoZWBYBQosBFpsBCkyJkAnYjtvGmLZHhecrUVilNyQFcCaYLI82sCXhR0sYYgiNvPg57TuoLDfbqGT3diJyLpb1tuAGdtefk9MrUUEqajh3YWySCCJBUqRAAiNt5JJM35YpZWLuWUIDlevw2LIWhcQxJ6bZnOMaBltHm9E+Kb1C0mtdiVi6Y7Gfelc7kECdXDmadANwap7qFWuiRLFYlVEiSQInMHQ3D8sRb5lgwi1oICyWtAjIkneT8hq4cDThBb/dkFDLXLBnDTMdomCMHGgC79Z0uuXAFOfEY4VSNwX92R3E47xqf60pwhlgXMItrXNBibIkLsZIgAgmNVrwdOWNglx1js3+ZdifWJ1wcvp2otuEMpkypmelplR2gGIxtjSaGFLzKnc63j7MTUb7qQAYZtgYzEzGdtePN6QRXlockILWucj8CRc2MyBtnbOorwqXs9olhDeTDHvDZj2k5jGofqykaYplOkGVALAof/AMbAykdrSI2EaKEG/p1O807pZRLeSiAettlJBBAJmM7agec0fDFS42kwnS0uYn7NYmpOYtBmCRjOojhU8Q1LYci0kSLh/iAw0Ridu251H9WUvDNOzomQoJ6T2NMzNODkWxHaNLQwn9OS/wAMGXiSACbREi8jCz2nftqlecUbDUv6JChoMOTsKePtJ7WzJkDUzwilxUjrAi4EgkeTR74+Mx21UnLKNrU/DFjNcVzAbGVEwmc9MZzuZ0aAm3NVFRUsfNstCgKak2qwLXBjEYUxImNG8JxS1ASswGZcxupIPykH6aXnlq+Ir3uLbemQVYpNpYkFiRO4YTAmdXcFy2nRLtTkXxIJJAiYtBON9NoBoDOmOlQadMA+tIIlgfFHpB0KW7nV3CG5aZOTGiuI1E43sV0K3M6rdvI6ZEC3YaGVRO2o+sMgMtqu/RVQZj11W2muMeRQX1XUqgZOiiNV8QMaJRpWFi9uYINz+WonmdPzOhuKGdDONcv2SspBz81pfiP00O/OaP4j9NA1FHkNBVBvrVSY6G555R/EfodRPPqP4j9DpEwydVNqsmFGj/XtH8R+h1z9e0fxH6HWbjXgNGTCjS/r2j+I/TUhz6j+I/Q6zYGp2jy0ZMKNF+vKP4j9Dr368o/iP0Os9GpKNNyYUaEc8o/i/I6kOdUfxH6HWe+mrKY0s2FGiHOKX4vyOprzal+L8tIE0Ug1EuSQUOF5rT/F+WrU5lTOzH6aUxojg9/pqVyyboKHNOqCN9WBtW8H7uiBrqULRNgobUgdG9te4ZtPAMgNXnVivopt9WOcD+u2moBYIoM40cza7SbGkHtHx1SkV8NrZLTgHa2Nx6nWsI0Tdn//2Q=="
        }
      ]
    }
  ]
}' 'https://dev.heliocor.com/dokstor-bo-api/api/job'
{
  "name": "John",
  "surname": "Doe",
  "gender": "MALE",
  "nationality": "GBR",
  "address": "77 Main Street",
  "addressCity": "London",
  "addressState": "London",
  "addressZipCode": "W1",
  "addressCountry": "UK",
  "birthDate": "1990-12-10",
  "email": "john4@doe.com",
  "phone": "+447022222222",
  "documentId": null,
  "documentType": "PASSPORT",
  "documentIssueDate": null,
  "documentExpirationDate": null,
  "callback": null,
  "expiration": null,
  "documents": [
    {
      "type": "PASSPORT",
      "datas": [
        {
          "index": 0,
          "content": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTEhMWFRUXGBoaFxgYGRgYHhsaGBgYGhoeGBoYHSgiGBolGx4aIjIhJSkrLi4uGyAzODMsNygtLisBCgoKDg0OGxAQGy8lHx8vLy0tLS0tLS0tLi0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLf/AABEIALsBDQMBIgACEQEDEQH/xAAbAAACAwEBAQAAAAAAAAAAAAAEBQIDBgEAB//EAEQQAAIBAwIEAwUEBwcDAwUAAAECEQMSIQAxBAUiQRNRYQYycYGRI0JSoRQVscHR4fAHM2JygpLSFlPxJDRDF0RjorL/xAAZAQADAQEBAAAAAAAAAAAAAAAAAQIDBAX/xAAkEQACAgICAgICAwAAAAAAAAAAAQIREiEDMUFRBBMiYTJx8P/aAAwDAQACEQMRAD8AK547rTklpyfecAE+UGBv28tLeQUapqIDUqwZMeI4BIkwRdttjvPrrUe2aJ4TT+Hf/MRvOQSPz1V7McJcatcqZAtUBScAqQIAxMRPaJ763pNGd+RvxXG3KpdDgAzkGMb2kA/T+Szi+YhtktCjEMwJAyZg7/1jR/EVVtDkgJ2JhR8MxntoEUEJiYB90EEFgfKdx66qEYJO2RJNiapx1MkEiGqDpZrjMqpiScEgggYO8d9Ro8dSpoTa5FrOT1npT3iBPYxpvW5WkAWSuIElgCLSsSTtapB9BrtTk6LTh6RAsK2m7KMZO5mPX+er+zJKKJuOTTQrbj1apkkE25F0G++yIMGbX9MeomjiuYI6ELNq1AjAE4ctYAYPmfoQdo0zp8EobxGQ5PvG45F0ESe1zfU6u/UqDqWmJkGboyGLq3vZ6yWHqdN/g7YJRjFiblnMREAk3A4zdj3tzKxIwfMRvOutx4vC5uYsqCD1FWCmM9iRvp9+pUcEGmhkQwLLkW256sqVgEH0Hloapw9JWgICZljmQSbultwbsyO+pUvsegai4i5ub03IvJ95BswnxGtjB3kQfLHmNWcz5utJTSCwAxmLouVfEIAJybTPlg99Mk5VSaIRSOxjaCjfKCiH4qD5HUeacAkl2QFHGDGD0qpnyaBB7x6acUm6ZTSSM+3F9SkRJBYQBsCBM/EjvnQtXjgSTubrT0j3urE7T0nG+34hLmpRQm4rd2GO0g/MSB9B5DURwlPBsPn04zn1kmGb/cddFEKhceOKnztZFIt/Hhd/M4mex8tGnmK0i6EMOi9lAMFYcyRMfcft2jvmFXhqQYQu5EyCNiWH0bM6cpwNCqLqlMMSoBJ7gKwH5M4/1N5nWPMl2XChA3HqJa3ADNcFAwGKkgiO43GDgg65U4wBjcBdKAgqpINQ2rMjOcfLT3juUUhlU94MD5EE3Hv3Yk/H46GfgKbZKS289/euHf8AFnXmzlFSaPU4oucUwKnzIPTZvuoMiwSN8WxIbHlmViZGpJzRKdMrdEAthZBUAm4R74A3HaVxkSXQopBFse787fdnzj+GpUOCpWhfDDAXAIZOCLMROLcR8NPiksqZn8rj/DL0epcWEpqWNgvKMbYKvmQTsg8jtkZzqVTmVIdTfiK3GcsrhGzPZyBnG/Yac0uGpsgVqeDdcpyDeCGuk9UgmZnfXX5dRMzT3M997lYkQcEsFJjcjOuu4nnaE45jTtBhrbFfIaAtQkKc7Se/7iNdp85owbcABiYByqF1cwPfAKN5+fcacDltC0KKcLYFABIhVYlQADgBtvKY21AcsoZBpGGm4XNm5mZp6u7Mx+Z0JxBoWUeZ0iyAQGckJgiSDBCsMFtzg7BiJtMdrc0phyrDqDWZDHq+zx5n+8T6+hhpT4CivSKfSCGjJFysHDAEwDeLp889zIPMqXDK0vQdmJvJBO/QLgbsHoTIiLRppphpAXH8ctRAFki8j70St1w7hSACf/IlZV4xUMggQ1hxgORIDdu4ycT66cHieGkRRqQCc3MILB7iIfchm+p1RxHA0VOFuV1xkwwNwhlmCYZtxmfTW8K6FaF/C8eGMAZMmIt2tmIgiJGx76eLx98XIq+pBMx6zPpk/wAdLeC8FQCqw0b5O4WYk4m1foNFfpansdEuOD7KToUj2srU1fxKBo0g0XVQVUkzAU2EtIBPoBkjTHlnOazeJS/RKlHobrINrQbYRgoBOQRBzGPVTwXs/SSozI1ZbzLCKbKeq4Sr02UwcgkGO2nnIvZuhQrmujVzUqBlc1O9zKxMhQSZAO/8uecIpGidmRo06ivIZzn8RIMEgiQdaWl4tPtM/iW76Xfu0Jx/CijxFrTZUggxEG8fvx/q1szSEmQ3yVfpkbDb66c4WlTHGdPaKPa/hvEanT3BK9u14Ijy7YyPro+pwJWnaikEusQCIwI+AHn6aI5vRniKQAwGTHYRJ0XxXCCocs6246WiZCnPnrklyVIErRmfaukQ1MSSCCAMklgYJI+EZ+Ok4q1KAg5otBKAwYJkxPuz3G2c603G8pWKh8Q9CloMHsTnP56z9PlrvWDKYRjDE9pUkz54B+Y1vxNNUyZL0OuH4tCgqL1qWG2IzPV+EjaO/bGia7E5nyIP8PTWUZa1KtFJSWiCoUsGWT7wHvLrVcPTc0rjSKkfcMGPOIMle8GCM7zq2oxiqIT220L61NwzMqgqCLVjJwpPyi8DzMdgZq4k1iDCAkXQfPBK7+uPQnEjaNDxhksWuBDbdxgjzIIB+Z8te4s10iGmYOPw2sO/mYPmMzcIlPKToSlCSdngaySbQWG2NlIGf82SIjGTrlThXJBtwVXAGzmZG52j89R4UV23eTnePxKf9XQG/rOiODNVLQ7SQeqDi2wYOMktv+7YL8uOQNQUQqjw3hqVOboJj08vh+eo83oBaQUkAz1CcywEGBsIAyfP10etMGGG3l5enw/r4Ae0Ff7AugB8MNk+gBXy6d+4/goyuVs0pVaM4rRi4GPKD+Q1OyPvDJ2kT9N5/Zpty/ljFbnRVMtgATEkAkBjGO0nf5aOXk6g5G/e0/GZ+J10/aiMTPpSBtB3J2PwO3Y+WNH8AFC2uwEbT5E/x/bpn+rAMGCJkgkeUdxn56gKRpG4yVIIkZiDImPi2dZ8vImqCq2C1+FlTaZ7gj+XbfQZoCTc0fkPOJOJjPz014OqVYgSymSFAkwdtzCrO07+Wl3NOJZKqg0qcMCTcLsKyKYKiR7wMnAg64eWDk7R1/H+RGMaZRTCgQCM/E7Ab+W/fV/J2TxSLlJtMZ8mMx/W2lrcc/UfDQQUIUUrsTVBAUSzRZuI3OMZa8v4G62oi2mA2IEFpJCuBDjybMg6XHxNO2Vz/JU4YoceGfL1+PlqtnVTDMBOROMfHbRXCowUBt/4nGe51JqCthgCO8j9v563OJAS1U/Gv1Hof3jXH4hMS652zgjIMHbcf1OlFSvVWjUfwqa1abC9TTBCoRMkrVNwCksSOoiRbnJVarUNV6Ypoy+H4lH7OSxDC4L9oBIuAyUy47A6AoLNanLKWAI3kx5dzjvq0umZdJ/zD+Px+mkg500JfSpsnh+JUgNC1LKptBb3WlAuQd2yIAayvxhS8GlRLUld2IUgMEp0mtAuwxFWJJIxt5MKGnEpSZbWKwYG/fffsdA1OWqkGxSu4cAfn/HbXqnMWEr4KOXJFFFXMiq6m+4gNAW/Ee6wGROnnCOlWkrJmnUUEYiVcTt2MHbTCvIp4PggUSLRKj9np/WNFJwJ2xPxGvcLwjAW72dO8TAEflGrkpvkAfH/AM9xOsXaNVTVlFSmFFzMoEgZI3YgLnzJxojh6yPaA6FuvZgfcNrfRjB9dV8fTYIstaDUpj3iszUURIBmfI77d50VUax/EY20lQgksYm5fuxnyme0RnQMU855enEkopBKgzaRhgwkHyMHTzhqKgC4wYWZgds75OdD8JSYVnvG4Yr1XdNwjsLR6Zjz1oKYxrdSpUSkKuKSeLp+hP5If46q5l7RcPSJUuSw3CgkyO04H56We1/GtSqh1a0gNHUVJ6VHTAILZ2bHx1i+EdalxqPBOZgmSZJnE6XFwxnJuZMptKka2lQWtVqcRX+zovTAW5gsggDJBxtt66U8xQSBTe5QeljifI/HJ/PVPHUzUZSKlMBVVB1CQqgDb4ydF84rU3tp0k6VVVBuXtPxGtnHa/1C/RHhi6EVLhIEHtI/ZP7dbDlPHeJcStqz0kznzkazFLgFpUxUq3kdltMn8ureJ29dA849oakWovhj1wf5a5ZJ9s01ejV8XQpliRHqJwTOJH1+MR5xxuFWosFhd2z5/wAdYVOaVXKS7zPUbmFyxiY7zq3ifaCtTIVHLPtaeoAesnp22301PGqObkmk8a7Ntyrl2LiO+Nux3+R12tyqGJ7eQ1L2Y9oFrixyBUA22nztByRrQmmD8dZvnlJ2Vx4yWhLw/BWjbcR8v6/rOvcTwjWwi3GdpjB37jTenTDd86D51wLNRqKsFivTJgTuJPYTidJSZ04pLQCqVR/8MjsC4+f5D11O2tiKI7Gb8euBEY/PSzheUVhXFZ1BUkk07py1evUVsYZqaupjIJJjKqdMPajhWeioRQxVrhLQJtcAsI6hJGxBHvAyo1d6EWq9bvSAwfvg5AwI+ON/XVFfmFlytBbIAUiclomTjpAM+sdtZnjuGZvHYe87MLenINRH6rsOYXAbABI7nRvI+SrejmmKiCmqi4qDScGoX6Vw14NPbyM7DSpeQdvSCuEdQAtwLEZgySe+e51bW4dWi9FaDIuAaCNjnY+us9zvkVTwaUIaK0/0glUK7u6tTm0xECJ7RHfU6HKqpDkAoWrmqr9AlRVqVEkqb2WCkhhtjbV6ZlVaHlHhKaklaaLJuJCqCWzkx3yc750VSpgAAAAAQAAAABgADy0Hyqky0KS1BDimgcTdDBRcJ7wcT30cjZ00Mo42qVwPy+Olq8WwMgzv/R034ujcPXQFPl5kSRH7dMC6nwFFkUeDTtBvC2LAY/eAiJ9d9TbllFr5o02vi/pXrIMi4xkzET30QEjbH7tWR5j+egAT9XUpVhSp3KtqGxcLEQuMLBIj1Oq05PQAVTTS1WuUWqAreaqAM7Z0wUjznz1ZHy0wAW5VQIcGjTIqG55ReogzL46jMnPnq+tUsUBRJOFUY+WNgB+Q1fHz0NxHDtd4ikSAMETtuAfuz56CWc4RIW5mktBJMDt+Q1EVQ5w6gduoXH1icY+OvZcIhRlAtLz5LGx9T5eWjP0dCIKr5xA1Cg3tminXQDx9UwopMSS6A2y+CwBmGEYJ6u2+dtFnh2CEI0N2JkgZzgEHb10NzPhKJCX+Gv2iQWUGTdIA2hidj21RVRqIuqOl0BBXKjpBcEKwnY7AzvGhw9Apew3hnDVm6WEKR1CJh4kTup7HTk42GkfDcOiVmCKFuBYgd2ZiST66dk5zpjXkyPtMyfpCVGUGxgVLNaisQLS/YiRgEgT3Gs9y6vw1wDqtRSimowNrq3UWgArcdyQASIA6tHe1bywYkQKkZm26xil0fduCzOMaTl2vUmVYuthAcPbMMOmG9ybgmNrd9Rk07RJuKPslwrgFbiDsQ5Ij0PfRZ5LQ4RTVAIsBMyx7ZiTGfhon2aINIREBmA+uZPxuPzEwZGl3t/xltJaY3c/kuf2xpqc3qUmy8UtpGE5xzypUe6TP3RPuz+zQL8DWquJYsBnfHaf3alwdDMkd9aHg1Gq5OZ1RUOKzNNy51kj6TtqKUmg200nzEz885+G2tg1CRtOgzwFrTMfn/R1zudjlwpqmZqhxDUnDKSrAzPkdbn2W9sndxS4iJPuuBAI9e3zxrHcy4aV+ck/EaF4dmp2tPusI+E4I1XZg+HF6PuD4Nw0LzNldGuNqqCzHGwBk5+vyGhuRcV4lJTPpqfM2TwnWoCUYFWjyIMz6RpdG3gT0eY0bqXXXBdVZVYiM1fDtbMBw0ys7K0TB1Tx3H0zSDA8QQ7BUl6S3SjVAwLVBapVWwxBztkauocPwOFUEKrqyBQwAZajOLABgXOwjaGjbVfDcJwYwj1FghlK9rVemqiVyIdgLgTtnA1fgloUVKIFxbxD4ZII7yBmI+XzjWh5VwINEOKlQBwGADdmEj550NU/RmvDtUIqEM9JgCv3DkAbEAAiYImJ0Xw3HcPSprTpkhFkKoUiBOyyBAEwPhHbUtpldCHmvMEsRvtrb3BRyrR4XS7YLCFY2nJz2xphynjFqXqoYWMyybdw7AgAMWEEEdQHppZV4Wgwpor1HpUgQGJEm60FCYEpCAnvJydNuA4JaZcqzG5mYg2wCzMxghQ27HBJjWiMnthrGDHlryj89RJ31NAN/TTsKJhvy10j89dbz10f19BqgIKdAcyr2m3yP89H6o4/hA+diBpBQu4eoVIg6e0zMaA4bl0e8Z0wTtphRInXVGuRqS50wo8B310Dtrw2/ryGvKNMALmTwKcGJqoPeKz1bYUzgbGAfMaq4rjVaizgoaJTpeTJYtaBbbtdGZ37d9FcfUZfDtnNRQYUHpIMzJFo9RJ9DqPNmbwytNodiqiROCerEj7gbP8NCYNA/JA97X5JEiWu6SzFcwIx27bSdPa7520n5W4NRoUqAoUTAPSzCcE4MSPQ6b8R72o8lIwnO1BosGBYNWKYs3NNyILe7JAEjOdL/AGN5dSqcRVRqZRqYypWIJKsYFQXLZIUEgE7nfDLnaj9EyrOTXKoVawq5RgjhgcBTB1jqK1qPi0hxI8Q1E6UhxUZqfvitUYCWMC098x06yfY4o+u8BaoSnTAVVEATtAgA+cDvrI+23H3cSw3FMBR8Tk/PI132brsEYg4Z2IJKmZVZMp0yXuJtwDIE7lDxPHG6oGgq7EkESD2HwPkdHDuzXlVUS4AifTTik6eY0kooBk4X1P7dD1uMRjaEz2iM/CN9OUGwjNRNlRbp0PxA30u5PxRAIYbDH7dKeZ8WDLEEx27b76yUPBpKVKwjmBFpEzGkyHYecg/u1dT4wVBaEtIAjYSPiNC1Hg5wQf3a0Soxk72fUvYuRwyz8PzOmvN3ZKFRkMMFkGJj1iD+w/DSj2HcNw4zsWn6z+/Trj3tQsHC2yWZiAAAMkkg41L7FWjOcPzLii1EmSt8ObQQVNcoDimC0rAuUJE3EWzq2pxzGg7+OccUULBKbQhrCmMeGf8A4yGmJzORjTHh+LqMt/iUWVpCkEwWutAnzmRG86T86upujPXQsSBY57kn3FjAA2O5g76qO2JnOYe0BniBRq3sPCslOmnd7xYhJj1a4DeIB0EnHcRVqUlqy1IinPSEyyViblAM5VchoxgZ1dR5qTcfFpKUAJDMBggmSBkbjviNs6tXmLlQUKvkdaglDNsSfOT28xq6/RPZPjqtjUlBFNGJBNoPVKwg8rpbb8OhjxrkcXbV6qVSEgIxAFNGg4z1lln/AAxuDo+rVqXQr0dyuSZuABKx3MZ+GoLxT9X2lHo97qm0yR1fh8s+X0VhRTX46yq6NXgJw95whOC0vG5IA22yND8HzRi3DA1kiorFiDTALBwLQY6okr0RJE6au9ULczU1AklhgWgqZltjF3pt8dW0uYUzZFWmTUHRDqb43tz1D4eWmOhf7MczqVlPigBlSmTAIBNS9pE7gpZ8DcO2HU/z1B6oUSTAHfUqbggEEEHY7/npsVFo9PlryjOMmfqdcQ6mB/4H7vXQh0eTtqfy1yNdUTphR4TqQ12NeE6YUexro1EajxHELTEtPoBkk+g0xUUce1MlAzAFGV8qGHcDJEITnO+l1wYUqqvkFAeIKBfEyQqgRsSzdoEk6lSDPWWED9ZNSS6sqQRDWta65ELBBiYmNNqTqpFQSKVRKS0xFWQSWAmkRFMdS9UD/FEDRLQVZRy7h0SrUVFCjpMAAZYszGB3Jkn46a1QJ0n5RRZHqB9+mepm3LEZbJwf6GnbrnadSMx/Hsg4Jb5tasDhS+xukqGWQLZyTtsdJuD5MHqFlYQS2VlyV8RiACwiJGDGBAzuNJxHACtwdOm2B75ZsAWsSJIIjHf4+mkJNRKXg0KlNnZwKbo4W+laWFjEwDJCmDnOuaabNOOSg22rNAnLLKWBaEQwN8AeffbXzatThSfnr6bXL0uCKu1zimQT5kjOfKT+Wvm3MfdK/Afv1pxxqIpScm2w3lJDgA/snTD9TKOq6WHb+GdI+UEqYOQPhrSLxC4Kz8+3lnWcpOLN4QUog1JbWNo7fH/xpfSpB7gRPnq3iPENRmQjz1HgUZWa8gyIxpt6tAo+GcHBBMgaz3MX6yPnrRcfxEDWWrZqH+vXRC3tk8yS0jef2c8T79P0uH7/ANo1s+Z0r6TJcEJiGOwIIIkSJExidfM/YqrbxSjzUj8p/dr6XzNgKTswuCqWiYm0E79ttN9mQuflbCpTqNXCstV3KC20+IzEgXC6602z5FsCTrvtLyg8QgVWVCCbmInpNKpTPxi+flqzlXDUqtFKlltwm2agxOMVFRgfio+e+iKfK6S7LBgiZPcQfy0raYCPgPZ0xVN1NyzBleSYKsjAFIhR0wSDMHTjiQpospVXdVuanTNslRMDMiTjPnonhaK05AEZ0t40o1ZqfhXWoKtRrisB/ECQB7+aTTkRjeTDtvYUZ2hyms/hKFtUBiWqzAd3SozJAwTUUwDMXDJ738NwVS2qh8O4Vr1BdirE1WqgRb0qQwggttMYjRHB85pGneOHOC9RockW01os7qWAuIvQWwMq2YEmrjwrmqadBhVp1FpGXwzscLnDDw2R5x/eKJBBjTKyRrxdHxKDU1KyyW493yjvA3E5j4jWfp8FY9P7RJpsSQGqORNZqhB6f/UMbol4KkltzqFTjL0vFK5ABlHYMSaI4nw1DAQWpsOrYExpxw9ei4I4embjGckKrGSTJgHBwczpjonUL1HtNymQQpxYvZmge+TMKTjvpnRphFCjtnOc7mfM6A4fktMSTLkkGSSDgDy32GdFLy2mIFgEep7GR3027HQUjqTAMnykT9NWgfP+vy+OhqHDKCWAyZn10SBnz9PP00go7qSb65qRH89NBRye2pTqJ15lkEZGNx2+GrFRB6qqJZgo7k4+WdJ3p3VLaLgsbmJFpI8xcAWbE4EY1YeXVFyCrwDBa45xsrSAx2mYEnGiOH5q1MLclxjd08KNulWAIxHePy1aVdBQ94virGprGajlZuQQbGaYYgvtEKCczEA6pPC1QBNctApzKIJtm8nGLxv5RjVHEc1pMAbKjRkMtMm0wRKkjJicidK+D45agBFfit6I6kGctEwkC8zce0dtYtMKCuU8T4ju8RNmJVtpG6kg/I6dzpNwQAqVAogSmBiMHy04jTJYragG4RQSFFqtJEgFYcSO4kCR3E6+d8dXhqaUmqUwAFuLZvaqXJuEGYZoDhSOrGdfUFT7JV/wqP8A9dfOec8rYH9Hq1FdrQKQVVQlnL2AtBJFwJIkDbqGsED7G9Xj1NHiLRVaiXIRz1ACAuC7XspecqCM6wtdibh3x+zT/hF4e1GpszSekVEqIoYgghqrLZapOWBJxgE75qq8k/MGMiVOYPfbVp6BEeUPErMZn66dJVMY31mVUhwV/oY044bi/PGpmrNuOVKi+nxFQkxaPnqvxql2YPz0dQpI24k/DUOMRVEgQNQmatgXEuTvpXwqXVWP9eWvcz4+BCjJMTq7l9OPp9daJUjCTtjv2ST/ANWnxI/I6+l8eegi2+cFc5BkHYH9nfWD9k+DIrBz32+sa3vHZpv0s/S3SphmxspkQTtMjUtiKafGnP2NQADuPLA+f11OpzC0LNGoZE4ExmIPrGdZqlwPEX8ObagC5YTgFqxLKZeVREIgw14wQsab+04qtTQ0hUZg8kUzbMK8BzepCloyJgxIKzorYWX1uMa4W0qgE5JHYZ2g75GY7aG4hg01Dw7l0Q2yDmZFuN9z5wC0b6B4qlXL8RHiAl0s/vQoTxKd0EVLYtn3FUwGydV8DQI4cPWquVKl6guJBElhN0thYG+YzPeoxGtgFEeIP7tgZUsBTAINoQZDHFiKCGBkBJHkXXoswZWFU+IyuwZFMuqqoJKlSAAijEbD11T4VVVoFQ8s9zquFF7KbWIOLFJAkFSFYGCVOorRrtet1QMaxkk1lHhzWt6r4iLP7uPuzq/6CwyC1x/RVDWBZJdViLfcAywHTgTECY0XyjhbTUaxELsWKqTFxLXtJA95s/8AnUOB4R1qAs7tFNASSbWfqDEJNoJAU/PVvGU2NWgylrQ5DKD0wadTLDv1BRnz0DGF2hV41sfZPmZwcDMZPcjt22+IPs5TdabK5c9XS7h1ZxaJJSozFcyOwO4A7i8yTimesqM6oxIRlm4TRpZHa0PfH+IHQA5HHnfw3A7YjMeWrhxZ28J5nsCe/T8zjHY6Qcu4XjLlFSqZV7nbIU/aBmRFiGW2UExAg76t5JzGomK61j0ozFwJDhftrciUByLZG8SI068AtjqnxrZmkwx3G+QP3k/LRHCVSwkqVIOx+AP8vlqD8bTAzUQf6h3276IpVAcggjzGqoDo10Tqt3AEkgfHGrVYHIII8xpgcqeY1ykTqurXVPeYL8SB5bTqqnVqPLUQhQd3JW8/4D5DzIg7aaQUV8yqJfTJZSablrQGZz0MIUKcGSNwcfUS4HiyKcNSqrc8gFDgVSSJjAjv5SNeFTwFo02UXVCQ7XAG4qzMRg3mRt2nUH5ccHxXYCzezNkzPT96c/lGspzXSEQ5NRsZ0kEgrtdGZP3iT9TrQ6zvIa/iM7QokoYUhhtGCAJ+mtA2qIl2Z720DHhQEKhg6EXMUncQGGzRJHqNJU9oQKKs0VOLWkq22sCas2kAkbXZMbgSO2iP7SnP6CADH2iTBjENO2vnFPhAotVVJjqMDfy9P36yqyUzS0+TpxIpGnULhCxqU6jJRIaqxPRCsE61Y2kEwRrN8x5X4b0xDR4QqSYlr52gmEHaYbGRopH6IBIAPugYODvkWjJ28yMa5xPEs+WMm23JY4GwFxMD00xrsX0gQRdvj4fId9M1Ram2DE4MjtvtH9RqVHgVa0+NTWT94wBnMxJmM7air0lVkDyxdQZUwVBgb4iMwT2jUspMpZnQSrdJ+evUVqP7xkHf+jppUFJAQ9WlAiIJbvj3Qcd5wB5ydQRaWOGp1B4j1EULDnFQiTfbaAJJ8/LcSFZezNcebXVbTEj6TGmXCVlvtuEjJH8NMv8ApuqHZWALKbXMOQCVBXKqRJBUAg9x5Egd/ZmmjGo9SmtQCShLkgghcgC0HYROraM1LZtfZRCyhowMCdaPj16GIJEZ6QScdgFIJPw0h5bxyUqdAZFNkZmcg9JUhRKgGZYx5yR6wxocxo10ZKHEC4oTckXICWUMAwwQwIyNxnWdFWBcPzVLkU1qhaoWUA0yIZXKEHOCGUjHlMgGdE8fVNILdXYXdIARnubqYmEBIAG52AXVSezqhqTeI58IKBhMhHZxBtlCSYYrF4HVOhvaCh+kstFWZVpvc7rb71htC7kMLpu7eumopvQJWC8x5oGLItdyikeJUVKnvFwoSnYOskkDpJwfTRfA0iVVkqkoVhQVjEECQcgjyPln0U1eBoIzIXlXqKzdAwVqK0O4AlZxHYN20fV4yKdnDKsxCki2mvYZ2PkFE61xNFFnjxSgqorkXMVUWFuqmQlQyJwHIEkgAkCdQq8cgUt4z2qbSfCqZIuwuOv3SJEjG41TwXBColCKlpp5MQWMMMz7yEhc5zewMmIhV5OgZKTlStSsXIiyffNrEElib4G22liFMIoca9dhTos1wS8lwyAqYggqpUgwczHltphWNRGVGqqGYgLFFyhJJgPUzaTBAyPz0z4fhQrlhAFiIFAAACFyIj/PHyGheM4e6vSqGpApgkU7LgWbF0zhokD0Leepy9E2Bcu54jqHZXW6Csq8OMQaciWGR276F4nioACV2mQCCpBHTaxgxJETbvmdNOV8vp0lIJkmoKnSnhqrAKvQq+6CBnJkk6ZP4bixhcD2IMGM9++Py1Sa9FJ+0KOC4HiHUN+kJBnqVCZEQDBIAznz7aF4zga6t9pULQwsqERTWTuVUzvjP7NaTxKaFEkKWkIoxNoLEKPQZ1KrXpw1zpABukrAA3uk+XnpZ7FkI+T8vLs2YsMXIJVpi6DOG2xkfnorh/ZhlJmuxU5gArsIAIDZA+Pp66PpcfQWotBSAxW5VVTEZjqAtBMMQCZIUkTB0wBAzq8n4E2KuG9nFXZhPYlATMiT1Ezj9up1fZ4FmZXKFjIsFtuRGxhhEiCMzpuH1XWrQCZ7anJiFCchZSWauXJIyyKTA2G8DOZjOiTQciDUJiRMREzGAYIAP5DV9ev8fln+s6GVz56UpWJuzjLFO1iWOY8++3eY0rox0/8Auf8A4sNd5GLvT8fy0bxPD3vTbp6GLZUMTKlekz0nO/y1WaZR2cLd4lim1VBEXdTMTlc/L56gCfLz9rV8pT/+dO51m+SUPDd0xgpsto90nABxrQvrVDl2Y/8AtGX/ANEoP/cp/SDr53SqljcCAx3GBkftyNfZOecjTiaS0qhYKGVumBkAxvPnpA/9nHD9qtX52nfywNZZpGWLPnq1BgYxudx8BqJI9Pz3+mt//wDTuj/3qn0XVZ/s8pf9+p9F0s0PFmBLA/Cd/TVTOucbnH5emt/U/s+pbCvUHyXVdT+zylH9/U+i6M4jp+j5xxBnGN87CdUtxBpMGpsVIaQ3cMDKmdfSR/ZxS/79Sf8AKuqKv9m1I/8A3FT/AGpoU4hTM1y+jV8GrzCvWTiAAQKT1HYXsAimosRes4QiNjIga0HsrxjfotOoy0vDcrRenbLOymw1V2BcmLkAyFLTcLTyp/ZrSA/9xVIJWRCZEgeWmY9j6dKnbRqVVIUgFSt5nJUOyk0lJibLfXTzT8jpmdre0Nam4Vek8LWFPwqTmpTqpZUYjrALOKliknaQcQ0VcHzAcPwtJKVVfHuDVHDp0h6gd0RT7wICqS0LiRrWcJ7J0EUDqAt90EATuetVDnPecwPTS6h7C0sE1ajDcKwRgsjYMylgJ7TnHfOi4j2B1vbuvUB+xK0Q1tR6bS0H7qsem74HIPbXh7Q0C4tY0FBAUm09nvimjEuSSvY7ZjTH/omnaE/Sa9oBhfs7c+S2gD5fnrnD+w9BQssS8dTQATvsVgqO28+erUkkUpNIA/60SnNKmilQWJfiGQG4sSSy0yxbtiAcD4C/gPa3iovrcN4lE4uRbZ8oV2OPrtvpnT9lKQz4lQwIEsTHkQWJOPLQ1T2JpPl6rsfMhLvk9t3yMj01LaZLtkR7RcJVDjw2pVQJUhIa7zB6czvJjfOp8t5+R4lU8PUqNhQZoqAANsVGKkme0T31On7IpaEPEVmSZKt4ZUnfIK4yZxGqW9g+HwQ7Kw+8BSB+hUhT/lA0ZaoeUqoqT2+a+G4cQNwrMXXfMMq3Y8hHqN9Sre2JanUtpOrMsU32EybTFrD5AtsR66J/6LpEQ9arUA926yVP+FlUMO2JjG2vJ7HUZjxavSBBuHeZ7T5fQd86NC2KV9rOLtE1UAZiZKG6CMABQ6wDsMHzO+m/Ae2iSq8QHVgZustkWtJiSD/pn66r4z2SZUtoVKjAnKVGRlUR90sCZJjz9TGu0vYrhwqAhlDGSnSQDaSRlTO0Xbnz01QU0P14OnXqpxK1r7IFO0yoHUHkAwS0xnItHrqjjfZtapYNVYC4ugCrKsaqVjJM3jxFUwRtIzo3guFSktlMBR8Nz5kzJProgMfMfT+elaChZ7QcuqVOum4kAqAKZuh1KMA6up8PN5XeVww7DUPZ6qg/947ZYy4YnqCjP2kNEESQcNtIDB31/iH+0/8ALVdjn7w/2n/loyChOOUcSrLbx1RltIqBw0ktALKVYWdOABFpyJyC5V2Wla7FiFPUdzvE+ZiJPcye+ueA/wCID/Sf+Wurwz/jX/Yf+Wpch0WF5z/X5a8p1wcM/wCNf9h/56mnCP8AjX/Yf+ejQmjtw0Px9RgoKkjrQGAGwWAO5Hbv23AOiP0R/wAa/wC0/wDLXqnAFhDFGAIMFDuDIPvbg50UCAORuxeoXm6UmVCnY9gTGPXWhbS/hOXlXdy4N5XAUiLRHmZ01NH11qmOXZCufd1GvWVRLMANsmM/PXq77H10m57yz9J8IE2qrlmICkwaVRMB1YfeHbadcsuxLoaE/TVFTiF/EAJjcb+Xx9NLjy8iutRXJVUsVW6rIUgNTM4Y7NIJI7jYoTyOuKKoVpdFRSApVZVaD0ibjROSxBhg5AnJxqaQ7Naa6g23C45iRMfDVYqqcyO0Z89vrrOcJyN1q8PULKRSp00I/wAlOqhZSVuwWAAJAIJmCBqg8jrPS8NmWmQKSKyMzStG/qIKrF10FAdphsyHS9js1IqA5GR6ag1dQCSwAG+Rj4+WlP6vYvQqEqvhrBpCWpjBE0/dtcbBiD0yIEzpeOTVCK6mxFqVabi0hjCV/EYy1PuMhWvAM5gwFS9hY+4qsIGRkqQJAmGBxJzrh4jfpON8pjvnqxjShuUlKlA0wGSmrA3MoPU6NMeGQdjhbO0QNreH4R18eadI33FWuN1S5nYLVlOkLcFGW+A21SSCw5uLxgHIx1Jnbbq22+uoU6ygAFgCqiRIxA7+WkPHezxq06AYKrUaVoCkxd0QJtEpKhtt1XVnE8qZjxQKqVrKwBLb3KohhZIGD949seVpIVj3xB5+fr/R17xNIKfKHsCtUkrVZoglaiTCCqsgsbYJz72dtEtwbCs9VWDEoQoce6YEBGHuoSJYQZMGcRopAMjXX8Qg+u8b/sOumuNgRJEjaY8/hrLvyB/BWkrJNN3akxkZam3vCO9RnkA+6floujy6otcPKlDliYu/uVphQLJADLcCHHvuCux06QDylxKtswOYwQc/x9NWeL2nO8emNZvgOX1qdBEtQujq0F8MFUA9QpCO+IPx0S/BVW4inXJVbVClcn3g5qQ0DF3h9s2TjToB09cKJLAD1Mft1AspIM77QSJA8s5xpG/LKi0atNCtRqjTdUkMVJAa5oaWCzaQoA6RGJM6vLmNSm4WmAFpDck0/CZmIp9PUGBsJ6cKDnYADlChmGkjeGJj4wdWhBvnHmSfTudIeB5Y9lamxNO92ZXpsLoao7/9sFcETJbvkaITlR+wNyg0gBYFIpmCOpUulXEdJkxPffQOx4H9dTu0lXlRmv8AauPGGHGKiTOEfawT0i3GcmdS/U5soC9R4TTaE+zfrDSyXf3giQ0mGJMHbU0gHgGug6VUuWnxKzeK0VVgH79PAEU32CfeAjDSZMwIfqY+FTp3rNNy0BISpkn7VLpZsyTd73VHbQFjoamDpX+rT41Sp4hN6Fc5anNv90/3VxJEEloM4jQr8iPgCl4g6WLe6basg44hbpqTPVBEkT6aVBZoQdSVtKf0E+P418grba2bNs0iDCT96QZxkRBFHIz4DUfFOXuvIy+BjiII8YGMwVkQMRJBGinUp0m/Vx8anWuEIseGRKr0sLqMEeGxmCTdK4EZm7k/AGl4kv4lzXXN759HaYaO0BYECMSaGN1OjQdLbo0yJ1cRSFfESYnaf46A5zzVaChmBNzBRBRc2sctUZVAhe58ho/jNl+P7tA8w4XxEsvZAfettllIIKywMAzuIONxrGf8tiXRRU5qFrrw9j3spYNNO2FiZF9wyYm2J+ulze0qeDVrmlUtpOUYXUSZUdUEVbTDdMTN2ADpg/LlNRKhZiKf92nTapsKSOm49JIgsRnbaBhyzDAVqlzkFqn2VxgQFjw7Yj/DPrqVQzlTnKCtToFXD1FDD3cSGMe9Ji0yVBAxnI1TT56rKSKVSfsyi9EutUkIy9cAYJ6iCANvOwcnpqyMpYBFRQkiD4QIQkkXSATsRPedVU+ToogPUB6LTKygpElAvTECTuDMmZ00lQWzp52sp0VIbw7j0QhquaaB+qZLgr0gxvMa5U57RCVnBuFAw8FNxg7npAMgloHS2YE68OToChueFCSJEOabl0L4mQ5LYIk76qbk1OGFz5tjI6LKniKFxsHz1TOxxjTpAXUecI60yqufEFwgA2rIEsQSIk4gmRkYBOqRz6n9p732YYthc2NaY6sZ/FE76jV5JTIQXN0G77puN/idUrA689MRJAgGNcHJKcuSWa8OINsAVHvYCFzLAe9Mdu+mkgOcR7QU1FMkN9qxQe6IZWCEZbqN2wWSQCRIGupzhGrPRhrqa3McEQLewJYHqESouzExqutyWmVVQXUKHUAEe47KxTIwotUCIIAGdWUuXqtU1QWk3QCRAvILEYnJA3JA7Rp6AhU5uBSFbw3tkhh0SsEg3AsJyIgEkzgamvMB4hQqwEkBzbaWChiB1XbHuIwdVVuXKQgDMtjM4ItPU5Yn3lI7mO489SPL1vZjJDT0E9MsoViBEyVEbxk+enSA5W5sopo4Vmv91RYD7rPm5gB0g4nU6XMkaoKYBJKLUnEWtdbgkNPSdh5ap/VFLw2pW9DNcVOQcgxmentA7aKHDqHNT7xVV7YCFyIxj3j+WgAOpztQjOyMtjhGUmkCCQGEtfYMEEywP5aJPMh4ipY2bQW6bQXBKg9UyY3AIyM6q4XltlLwlqVLfPoBA7iQg3ySd5JzqQ5aoZWBYBQosBFpsBCkyJkAnYjtvGmLZHhecrUVilNyQFcCaYLI82sCXhR0sYYgiNvPg57TuoLDfbqGT3diJyLpb1tuAGdtefk9MrUUEqajh3YWySCCJBUqRAAiNt5JJM35YpZWLuWUIDlevw2LIWhcQxJ6bZnOMaBltHm9E+Kb1C0mtdiVi6Y7Gfelc7kECdXDmadANwap7qFWuiRLFYlVEiSQInMHQ3D8sRb5lgwi1oICyWtAjIkneT8hq4cDThBb/dkFDLXLBnDTMdomCMHGgC79Z0uuXAFOfEY4VSNwX92R3E47xqf60pwhlgXMItrXNBibIkLsZIgAgmNVrwdOWNglx1js3+ZdifWJ1wcvp2otuEMpkypmelplR2gGIxtjSaGFLzKnc63j7MTUb7qQAYZtgYzEzGdtePN6QRXlockILWucj8CRc2MyBtnbOorwqXs9olhDeTDHvDZj2k5jGofqykaYplOkGVALAof/AMbAykdrSI2EaKEG/p1O807pZRLeSiAettlJBBAJmM7agec0fDFS42kwnS0uYn7NYmpOYtBmCRjOojhU8Q1LYci0kSLh/iAw0Ridu251H9WUvDNOzomQoJ6T2NMzNODkWxHaNLQwn9OS/wAMGXiSACbREi8jCz2nftqlecUbDUv6JChoMOTsKePtJ7WzJkDUzwilxUjrAi4EgkeTR74+Mx21UnLKNrU/DFjNcVzAbGVEwmc9MZzuZ0aAm3NVFRUsfNstCgKak2qwLXBjEYUxImNG8JxS1ASswGZcxupIPykH6aXnlq+Ir3uLbemQVYpNpYkFiRO4YTAmdXcFy2nRLtTkXxIJJAiYtBON9NoBoDOmOlQadMA+tIIlgfFHpB0KW7nV3CG5aZOTGiuI1E43sV0K3M6rdvI6ZEC3YaGVRO2o+sMgMtqu/RVQZj11W2muMeRQX1XUqgZOiiNV8QMaJRpWFi9uYINz+WonmdPzOhuKGdDONcv2SspBz81pfiP00O/OaP4j9NA1FHkNBVBvrVSY6G555R/EfodRPPqP4j9DpEwydVNqsmFGj/XtH8R+h1z9e0fxH6HWbjXgNGTCjS/r2j+I/TUhz6j+I/Q6zYGp2jy0ZMKNF+vKP4j9Dr368o/iP0Os9GpKNNyYUaEc8o/i/I6kOdUfxH6HWe+mrKY0s2FGiHOKX4vyOprzal+L8tIE0Ug1EuSQUOF5rT/F+WrU5lTOzH6aUxojg9/pqVyyboKHNOqCN9WBtW8H7uiBrqULRNgobUgdG9te4ZtPAMgNXnVivopt9WOcD+u2moBYIoM40cza7SbGkHtHx1SkV8NrZLTgHa2Nx6nWsI0Tdn//2Q=="
        }
      ]
    }
  ]
}

POST https://dev.heliocor.com/dokstor-bo-api/api/job

Adds a job

Adds a job.

Parameters

Parameter Type Required Description
name string true Name
surname string true Surname
gender string true Gender. Can be MALE or FEMALE
nationality string true Nationality in 3 character ISO 3116-1 format
address string false Address
addressCity string false Address City
addressState string false Address State
addressZipCode string false Address Zip Code (Post code)
addressCountry string false Address Country
birthDate string(date-time) false Date of birth
email string true Email
phone string false Phone number
documentId string false ID of the document
documentType string false Type of document. Can be NATIONAL_ID or PASSPORT
documentIssueDate string(date-time) false Document issue date
documentExpirationDate string(date-time) false Document expiration date
callback string false Insert here the URL of your service to be automatically invoked when the job finishes. The information will be sent as a POST request, like shown in the screenshot below
expiration string(date-time) false Expiration date of the job. It will be deleted on the chosen date
documents [Object Document] false Object Document

CallBack Response

callback

This callback will send back the job id. Then you will need to call the endpoint Get a Job Information to get the rest of the job.

Object Document

Parameter Type Required Description
type string false [Type of Document]
datas [Object Document Data] false Document Data

To see the available types of documents you should use this endpoint: [Type of Document]

Object Document Data

Parameter Type Required Description
index integer(int32) true Element number of document
content string(base64) false Image binary on base 64

The field content of the Object Document Data stores the binary data in base 64 of your image. Please, convert the image to base 64 before sending it in the API call.

In the Example request on the right column, the value of content is the base64 string of the image below

Callback Response Parameters

Parameter Description
identifier Identifier of the created job
status Status of the created job

This callback is a POST request that will be send to the URL that you define

If you want to retrieve all the job information, use the endpoint defined in the section Get a Job Information and pass the value that you get as identifier.

Example Response (JSON)

{
    "job": {
        "identifier": "4d10112d2e3145c682db4ab62eca054f",
        "payload": {},
        "status": "PENDING",
        "timestamp": "2018-09-13T13:07:49",
        "person": {
            "identifier": "76549dbc45e44e8aa4f530e04b2a4de1",
            "type": "CANDIDATE",
            "name": "John",
            "surname": "Doe",
            "gender": "MALE",
            "nationality": "GBR",
            "address": "77 Main Street",
            "addressCity": "London",
            "addressState": "London",
            "addressZipCode": "W1",
            "addressCountry": "UK",
            "birthDate": "1990-12-10",
            "email": "john4@doe.com",
            "phone": "+447022222222",
            "documentType": "PASSPORT",
            "aml": {},
            "status": "PENDING",
            "timestamp": "2018-09-13T13:07:49",
            "documents": [
                {
                    "identifier": "125ccc252fc541369942f2e3021bb9bc",
                    "type": "",
                    "status": "REVIEW",
                    "timestamp": "2018-09-13T13:07:49",
                    "datas": [
                        {
                            "identifier": "513d431761e84d919ad26001457dbbda",
                            "index": 0,
                            "timestamp": "2018-09-13T13:07:49"
                        }
                    ]
                }
            ]
        }
    }
}
{
    "job": {
        "identifier": "4d10112d2e3145c682db4ab62eca054f",
        "payload": {},
        "status": "PENDING",
        "timestamp": "2018-09-13T13:07:49",
        "person": {
            "identifier": "76549dbc45e44e8aa4f530e04b2a4de1",
            "type": "CANDIDATE",
            "name": "John",
            "surname": "Doe",
            "gender": "MALE",
            "nationality": "GBR",
            "address": "77 Main Street",
            "addressCity": "London",
            "addressState": "London",
            "addressZipCode": "W1",
            "addressCountry": "UK",
            "birthDate": "1990-12-10",
            "email": "john4@doe.com",
            "phone": "+447022222222",
            "documentType": "PASSPORT",
            "aml": {},
            "status": "PENDING",
            "timestamp": "2018-09-13T13:07:49",
            "documents": [
                {
                    "identifier": "125ccc252fc541369942f2e3021bb9bc",
                    "type": "",
                    "status": "REVIEW",
                    "timestamp": "2018-09-13T13:07:49",
                    "datas": [
                        {
                            "identifier": "513d431761e84d919ad26001457dbbda",
                            "index": 0,
                            "timestamp": "2018-09-13T13:07:49"
                        }
                    ]
                }
            ]
        }
    }
}

Callback Response (JSON)

{
        "identifier": "e90eaa3c5eee46aca0ea8460aa598ada",
        "status": "COMPLETED"
      }
      
{
        "identifier": "e90eaa3c5eee46aca0ea8460aa598ada",
        "status": "COMPLETED"
      }
      

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get a Job Information

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/job/{jobid}'

GET https://dev.heliocor.com/dokstor-bo-api/api/job/{jobid}

Returns the job information

Returns the job information.

URL Parameters

Parameter Type Required Description
jobid string true Job identifier

Example response (JSON)

{
        "job": {
            "identifier": "4d10112d2e3145c682db4ab62eca054f",
            "payload": {},
            "status": "PENDING",
            "timestamp": "2018-09-13T13:07:49",
            "person": {
                "identifier": "76549dbc45e44e8aa4f530e04b2a4de1",
                "type": "CANDIDATE",
                "name": "John",
                "surname": "Doe",
                "gender": "MALE",
                "nationality": "GBR",
                "address": "77 Main Street",
                "addressCity": "London",
                "addressState": "London",
                "addressZipCode": "W1",
                "addressCountry": "UK",
                "birthDate": "1990-12-10",
                "email": "john4@doe.com",
                "phone": "+447022222222",
                "documentType": "PASSPORT",
                "aml": {},
                "status": "PENDING",
                "timestamp": "2018-09-13T13:07:49",
                "documents": [
                    {
                        "identifier": "125ccc252fc541369942f2e3021bb9bc",
                        "type": "",
                        "status": "REVIEW",
                        "timestamp": "2018-09-13T13:07:49",
                        "datas": [
                            {
                                "identifier": "513d431761e84d919ad26001457dbbda",
                                "index": 0,
                                "timestamp": "2018-09-13T13:07:49"
                            }
                        ]
                    }
                ]
            }
        }
    }
    
{
        "job": {
            "identifier": "4d10112d2e3145c682db4ab62eca054f",
            "payload": {},
            "status": "PENDING",
            "timestamp": "2018-09-13T13:07:49",
            "person": {
                "identifier": "76549dbc45e44e8aa4f530e04b2a4de1",
                "type": "CANDIDATE",
                "name": "John",
                "surname": "Doe",
                "gender": "MALE",
                "nationality": "GBR",
                "address": "77 Main Street",
                "addressCity": "London",
                "addressState": "London",
                "addressZipCode": "W1",
                "addressCountry": "UK",
                "birthDate": "1990-12-10",
                "email": "john4@doe.com",
                "phone": "+447022222222",
                "documentType": "PASSPORT",
                "aml": {},
                "status": "PENDING",
                "timestamp": "2018-09-13T13:07:49",
                "documents": [
                    {
                        "identifier": "125ccc252fc541369942f2e3021bb9bc",
                        "type": "",
                        "status": "REVIEW",
                        "timestamp": "2018-09-13T13:07:49",
                        "datas": [
                            {
                                "identifier": "513d431761e84d919ad26001457dbbda",
                                "index": 0,
                                "timestamp": "2018-09-13T13:07:49"
                            }
                        ]
                    }
                ]
            }
        }
    }
    

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get all Jobs

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/job?first=0&max=50'

GET https://dev.heliocor.com/dokstor-bo-api/api/job

Returns the list of jobs

Returns the list of jobs.

URL Parameters

Parameter Type Required Description
first integer(int32) false First job [0, -]
max integer(int32) false Max jobs [1-100]

Example response (JSON)

{
  "count": 0,
  "jobs": [
    {
      "identifier": "string",
      "callback": "string",
      "payload": {
        "property1": "string",
        "property2": "string"
      },
      "expiration": "string",
      "status": "string",
      "timestamp": "string",
      "person": {
        "identifier": "string",
        "type": "string",
        "name": "string",
        "surname": "string",
        "gender": "string",
        "nationality": "string",
        "otherNationalities": [
          "string"
        ],
        "address": "string",
        "addressCity": "string",
        "addressState": "string",
        "addressZipCode": "string",
        "addressCountry": "string",
        "birthDate": "string",
        "email": "string",
        "phone": "string",
        "documentId": "string",
        "documentType": "string",
        "documentIssueDate": "string",
        "documentExpirationDate": "string",
        "aml": {
          "property1": "string",
          "property2": "string"
        },
        "status": "string",
        "statusidentity": "string",
        "statusaml": "string",
        "statusdocument": "string",
        "statusaddress": "string",
        "timestamp": "string",
        "documents": [
          {
            "identifier": "string",
            "type": "string",
            "status": "string",
            "timestamp": "string",
            "datas": [
              {
                "identifier": "string",
                "index": 0,
                "content": "string",
                "timestamp": "string"
              }
            ],
            "properties": [
              {
                "identifier": "string",
                "name": "string",
                "value": "string",
                "timestamp": "string"
              }
            ]
          }
        ],
        "action": "string",
        "actionDate": "string"
      }
    }
  ]
}
{
  "count": 0,
  "jobs": [
    {
      "identifier": "string",
      "callback": "string",
      "payload": {
        "property1": "string",
        "property2": "string"
      },
      "expiration": "string",
      "status": "string",
      "timestamp": "string",
      "person": {
        "identifier": "string",
        "type": "string",
        "name": "string",
        "surname": "string",
        "gender": "string",
        "nationality": "string",
        "otherNationalities": [
          "string"
        ],
        "address": "string",
        "addressCity": "string",
        "addressState": "string",
        "addressZipCode": "string",
        "addressCountry": "string",
        "birthDate": "string",
        "email": "string",
        "phone": "string",
        "documentId": "string",
        "documentType": "string",
        "documentIssueDate": "string",
        "documentExpirationDate": "string",
        "aml": {
          "property1": "string",
          "property2": "string"
        },
        "status": "string",
        "statusidentity": "string",
        "statusaml": "string",
        "statusdocument": "string",
        "statusaddress": "string",
        "timestamp": "string",
        "documents": [
          {
            "identifier": "string",
            "type": "string",
            "status": "string",
            "timestamp": "string",
            "datas": [
              {
                "identifier": "string",
                "index": 0,
                "content": "string",
                "timestamp": "string"
              }
            ],
            "properties": [
              {
                "identifier": "string",
                "name": "string",
                "value": "string",
                "timestamp": "string"
              }
            ]
          }
        ],
        "action": "string",
        "actionDate": "string"
      }
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get Job Summary

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/job/summary'

GET https://dev.heliocor.com/dokstor-bo-api/api/job/summary

Returns the job summary

Returns the job summary.

Example response (JSON)

{
  "summary": {
    "property1": [
      {
        "count": 0,
        "date": "string"
      }
    ],
    "property2": [
      {
        "count": 0,
        "date": "string"
      }
    ]
  }
}
{
  "summary": {
    "property1": [
      {
        "count": 0,
        "date": "string"
      }
    ],
    "property2": [
      {
        "count": 0,
        "date": "string"
      }
    ]
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update a Job

Example Request

# You can also use wget
curl -X PUT 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "callback": "string",
  "expiration": "2018-09-10T14:37:13.460Z"
}' 'https://dev.heliocor.com/dokstor-bo-api/api/job/{jobid}'
{
  "callback": "string",
  "expiration": "2018-09-10T14:37:13.460Z"
}

PUT https://dev.heliocor.com/dokstor-bo-api/api/job/{jobid}

Updates the job

Updates the job.

URL Parameters

Parameter Type Required Description
jobid string true Job identifier

Parameters

Parameter Type Required Description
callback string false URL to which an extra response will be sent
expiration string(date-time) false Expiration date of the job. It will be deleted on the chosen date

Example response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete a Job

Example Request

curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/job/{jobid}'

DELETE https://dev.heliocor.com/dokstor-bo-api/api/job/{jobid}

Cancels the job

Cancels the job.

URL Parameters

Parameter Type Required Description
jobid string true Job identifier

Example Response (JSON)

{}
{}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get Job Audits

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/job/{jobid}/audit'

GET https://dev.heliocor.com/dokstor-bo-api/api/job/{jobid}/audit

Returns the list of job audit events

Returns the list of job audit events, sorted by timestamp.

URL Parameters

Parameter Type Required Description
jobid string true Job identifier
first integer(int32) false First audit event [0, -]
max integer(int32) false Max audit events [1-100]

Example Response (JSON)

{
  "count": 0,
  "audits": [
    {
      "identifier": "string",
      "type": "string",
      "message": "string",
      "payload": {
        "property1": "string",
        "property2": "string"
      },
      "timestamp": "string"
    }
  ]
}
{
  "count": 0,
  "audits": [
    {
      "identifier": "string",
      "type": "string",
      "message": "string",
      "payload": {
        "property1": "string",
        "property2": "string"
      },
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Example Response (JSON)

{
            "types": [
              "PASSPORT",
              "IDENTITY_CARD_FRONT",
              "IDENTITY_CARD_BACK",
              "DRIVING_LICENSE",
              "SELFIE",
              "BIRTH_CERTIFICATE",
              "BANK_STATEMENT_PERSONAL",
              "MARRIAGE_CERTIFICATE",
              "DIVORCE_DOCUMENTS",
              "PAYSLIP",
              "PERSONAL_ADDRESS",
              "PREVIOUS_ADDRESSES",
              "PROOF_OF_AGE",
              "RIGHT_TO_REMAIN_RESIDENCE",
              "VISA_RESIDENCE",
              "ELECTRICITY_BILL",
              "WATER_BILL",
              "GAS_BILL",
              "TELEPHONE_BILL",
              "COUNCIL_TAX_BILL",
              "COMPANY_DATA",
              "PROFIT_AND_LOSS",
              "BALANCE_SHEET",
              "BANK_STATEMENT_COMPANY",
              "OTHER_PARTIES",
              "HOME_INSURANCE_CERTIFICATE",
              "CAR_INSURANCE_CERTIFICATE",
              "LIFE_INSURANCE_CERTIFICATE",
              "HEALTH_INSURANCE_CERTIFICATE",
              "DEGREE_CERTIFICATES",
              "SCHOOL_EXAM_CERTIFICATES",
              "STUDENT_UNION_CATEGORY",
              "MEMBERSHIP_CATEGORIES"
            ]
          }
          
{
            "types": [
              "PASSPORT",
              "IDENTITY_CARD_FRONT",
              "IDENTITY_CARD_BACK",
              "DRIVING_LICENSE",
              "SELFIE",
              "BIRTH_CERTIFICATE",
              "BANK_STATEMENT_PERSONAL",
              "MARRIAGE_CERTIFICATE",
              "DIVORCE_DOCUMENTS",
              "PAYSLIP",
              "PERSONAL_ADDRESS",
              "PREVIOUS_ADDRESSES",
              "PROOF_OF_AGE",
              "RIGHT_TO_REMAIN_RESIDENCE",
              "VISA_RESIDENCE",
              "ELECTRICITY_BILL",
              "WATER_BILL",
              "GAS_BILL",
              "TELEPHONE_BILL",
              "COUNCIL_TAX_BILL",
              "COMPANY_DATA",
              "PROFIT_AND_LOSS",
              "BALANCE_SHEET",
              "BANK_STATEMENT_COMPANY",
              "OTHER_PARTIES",
              "HOME_INSURANCE_CERTIFICATE",
              "CAR_INSURANCE_CERTIFICATE",
              "LIFE_INSURANCE_CERTIFICATE",
              "HEALTH_INSURANCE_CERTIFICATE",
              "DEGREE_CERTIFICATES",
              "SCHOOL_EXAM_CERTIFICATES",
              "STUDENT_UNION_CATEGORY",
              "MEMBERSHIP_CATEGORIES"
            ]
          }
          

Responses

Securities

Get Security

Example Request

# You can also use wget

curl -X GET https://dev.heliocor.com/blotter-api/api/static/security/{securityid}
  -H 'Accept: application/json'

GET https://dev.heliocor.com/blotter-api/api/static/security/{securityid}

Returns a security

Returns a security.

Parameters

Parameter Type Required Description
securityid string true Security id

Example Response (JSON)

{
  "security": {
    "identifier": "string",
    "externalId": "string",
    "isin": "string",
    "name": "string",
    "classification": "string",
    "commoditiesOrEmissionIndicator": true,
    "issuerIdCode": "string",
    "tradingVenueIdCode": "string",
    "shortName": "string",
    "requestForAdmissionToTradingIndicator": true,
    "admissionToTradingApprovalDate": "string",
    "admissionToTradingRequestDate": "string",
    "admissionToTradingDate": "string",
    "terminationDate": "string",
    "notionalCurrency1": "string",
    "nominalAmount": "string",
    "nominalAmountCurrency": "string",
    "maturityDate": "string",
    "nominalAmountPerUnit": "string",
    "fixedRate": "string",
    "floatingRateIndexISIN": "string",
    "floatingRateIndexName": "string",
    "floatingRateIndexNameType": "string",
    "floatingRateIndexTerm": "string",
    "floatingRateIndexPointSpread": "string",
    "bondSeniority": "string",
    "expiryDate": "string",
    "priceMultiplier": "string",
    "underlyingInstrumentISIN": "string",
    "underlyingIssuer": "string",
    "underlyingIndexName": "string",
    "underlyingIndexNameType": "string",
    "underlyingIndexTerm": "string",
    "optionType": "string",
    "strikePrice": "string",
    "strikePriceType": "string",
    "strikePriceCurrency": "string",
    "optionExerciseStyle": "string",
    "settlementType": "string",
    "baseProduct": "string",
    "subProduct": "string",
    "furtherSubProduct": "string",
    "transactionType": "string",
    "finalPriceType": "string",
    "referenceRate": "string",
    "referenceRateType": "string",
    "irContractTerm": "string",
    "irNominalCurrency2": "string",
    "fixedRateLeg1": "string",
    "fixedRateLeg2": "string",
    "floatingRateLeg2": "string",
    "floatingRateLeg2Type": "string",
    "contractTermLeg2": "string",
    "fxNominalCurrency2": "string",
    "fxType": "string",
    "source": "string",
    "timestamp": "string"
  }
}
{
  "security": {
    "identifier": "string",
    "externalId": "string",
    "isin": "string",
    "name": "string",
    "classification": "string",
    "commoditiesOrEmissionIndicator": true,
    "issuerIdCode": "string",
    "tradingVenueIdCode": "string",
    "shortName": "string",
    "requestForAdmissionToTradingIndicator": true,
    "admissionToTradingApprovalDate": "string",
    "admissionToTradingRequestDate": "string",
    "admissionToTradingDate": "string",
    "terminationDate": "string",
    "notionalCurrency1": "string",
    "nominalAmount": "string",
    "nominalAmountCurrency": "string",
    "maturityDate": "string",
    "nominalAmountPerUnit": "string",
    "fixedRate": "string",
    "floatingRateIndexISIN": "string",
    "floatingRateIndexName": "string",
    "floatingRateIndexNameType": "string",
    "floatingRateIndexTerm": "string",
    "floatingRateIndexPointSpread": "string",
    "bondSeniority": "string",
    "expiryDate": "string",
    "priceMultiplier": "string",
    "underlyingInstrumentISIN": "string",
    "underlyingIssuer": "string",
    "underlyingIndexName": "string",
    "underlyingIndexNameType": "string",
    "underlyingIndexTerm": "string",
    "optionType": "string",
    "strikePrice": "string",
    "strikePriceType": "string",
    "strikePriceCurrency": "string",
    "optionExerciseStyle": "string",
    "settlementType": "string",
    "baseProduct": "string",
    "subProduct": "string",
    "furtherSubProduct": "string",
    "transactionType": "string",
    "finalPriceType": "string",
    "referenceRate": "string",
    "referenceRateType": "string",
    "irContractTerm": "string",
    "irNominalCurrency2": "string",
    "fixedRateLeg1": "string",
    "fixedRateLeg2": "string",
    "floatingRateLeg2": "string",
    "floatingRateLeg2Type": "string",
    "contractTermLeg2": "string",
    "fxNominalCurrency2": "string",
    "fxType": "string",
    "source": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Security

Example Request

curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "externalId": "string",
  "isin": "string",
  "name": "string",
  "classification": "string",
  "commoditiesOrEmissionIndicator": true,
  "issuerIdCode": "string",
  "tradingVenueIdCode": "string",
  "shortName": "string",
  "requestForAdmissionToTradingIndicator": true,
  "admissionToTradingApprovalDate": "2018-10-08T15:26:26.552Z",
  "admissionToTradingRequestDate": "2018-10-08T15:26:26.552Z",
  "admissionToTradingDate": "2018-10-08T15:26:26.552Z",
  "terminationDate": "2018-10-08T15:26:26.552Z",
  "notionalCurrency1": "string",
  "nominalAmount": "string",
  "nominalAmountCurrency": "string",
  "maturityDate": "2018-10-08T15:26:26.552Z",
  "nominalAmountPerUnit": "string",
  "fixedRate": "string",
  "floatingRateIndexISIN": "string",
  "floatingRateIndexName": "string",
  "floatingRateIndexNameType": "string",
  "floatingRateIndexTerm": "string",
  "floatingRateIndexPointSpread": "string",
  "bondSeniority": "string",
  "expiryDate": "2018-10-08T15:26:26.552Z",
  "priceMultiplier": "string",
  "underlyingInstrumentISIN": "string",
  "underlyingIssuer": "string",
  "underlyingIndexName": "string",
  "underlyingIndexNameType": "string",
  "underlyingIndexTerm": "string",
  "optionType": "string",
  "strikePrice": "string",
  "strikePriceType": "string",
  "strikePriceCurrency": "string",
  "optionExerciseStyle": "string",
  "settlementType": "string",
  "baseProduct": "string",
  "subProduct": "string",
  "furtherSubProduct": "string",
  "transactionType": "string",
  "finalPriceType": "string",
  "referenceRate": "string",
  "referenceRateType": "string",
  "irContractTerm": "string",
  "irNotionalCurrency2": "string",
  "fixedRateLeg1": "string",
  "fixedRateLeg2": "string",
  "floatingRateLeg2": "string",
  "floatingRateLeg2Type": "string",
  "contractTermLeg2": "string",
  "fxNotionalCurrency2": "string",
  "fxType": "string",
  "source": "string"
}' 'https://dev.heliocor.com/blotter-api/api/static/security/{securityid}'

POST https://dev.heliocor.com/blotter-api/api/static/security/{securityid}

Updates a security

Updates a security.

{
  "externalId": "string",
  "isin": "string",
  "name": "string",
  "classification": "string",
  "commoditiesOrEmissionIndicator": true,
  "issuerIdCode": "string",
  "tradingVenueIdCode": "string",
  "shortName": "string",
  "requestForAdmissionToTradingIndicator": true,
  "admissionToTradingApprovalDate": "2018-10-08T14:50:16Z",
  "admissionToTradingRequestDate": "2018-10-08T14:50:16Z",
  "admissionToTradingDate": "2018-10-08T14:50:16Z",
  "terminationDate": "2018-10-08T14:50:16Z",
  "notionalCurrency1": "string",
  "nominalAmount": "string",
  "nominalAmountCurrency": "string",
  "maturityDate": "2018-10-08T14:50:16Z",
  "nominalAmountPerUnit": "string",
  "fixedRate": "string",
  "floatingRateIndexISIN": "string",
  "floatingRateIndexName": "string",
  "floatingRateIndexNameType": "string",
  "floatingRateIndexTerm": "string",
  "floatingRateIndexPointSpread": "string",
  "bondSeniority": "string",
  "expiryDate": "2018-10-08T14:50:16Z",
  "priceMultiplier": "string",
  "underlyingInstrumentISIN": "string",
  "underlyingIssuer": "string",
  "underlyingIndexName": "string",
  "underlyingIndexNameType": "string",
  "underlyingIndexTerm": "string",
  "optionType": "string",
  "strikePrice": "string",
  "strikePriceType": "string",
  "strikePriceCurrency": "string",
  "optionExerciseStyle": "string",
  "settlementType": "string",
  "baseProduct": "string",
  "subProduct": "string",
  "furtherSubProduct": "string",
  "transactionType": "string",
  "finalPriceType": "string",
  "referenceRate": "string",
  "referenceRateType": "string",
  "irContractTerm": "string",
  "irNotionalCurrency2": "string",
  "fixedRateLeg1": "string",
  "fixedRateLeg2": "string",
  "floatingRateLeg2": "string",
  "floatingRateLeg2Type": "string",
  "contractTermLeg2": "string",
  "fxNotionalCurrency2": "string",
  "fxType": "string",
  "source": "string"
}

URL Parameters

Parameter Type Required Description
securityid string true Security id

Parameters

Name Type Required Description
externalId string false none
isin string false ISIN code (ISO 6166 standard)
name string false The character set used should be UTF-8
classification string false CFI code (ISO 10962 standard)
commoditiesOrEmissionIndicator boolean false ’True’, ‘False’
issuerIdCode string false LEI code (ISO 17442 standard)
tradingVenueIdCode string false MIC code (ISO 10383 standard)
shortName string false FISN code (ISO 18774 standard)
requestForAdmissionToTradingIndicator boolean false ’True’, ‘False’
admissionToTradingApprovalDate string(date-time) false The date should be sent in the ISO 8601 date format standard YYYY-MM-DDThh:mm:ss.ddddddZ. Dates and times must be reported in UTC.
admissionToTradingRequestDate string(date-time) false The date should be sent in the ISO 8601 date format standard YYYY-MM-DDThh:mm:ss.ddddddZ.Dates and times shall be reported in UTC.
admissionToTradingDate string(date-time) false The date should be sent in the ISO 8601 date format standard YYYY-MM-DDThh:mm:ss.ddddddZ.Dates and times shall be reported in UTC.
terminationDate string(date-time) false The date should be sent in the ISO 8601 date format standard YYYY-MM-DDThh:mm:ss.ddddddZ. Dates and times shall be reported in UTC.
notionalCurrency1 string false 3 letter currency code (ISO 4217 standard).
nominalAmount string false Must be expressed in the currency reported under field nominalAmountCurrency
nominalAmountCurrency string false 3 letter currency code (ISO 4217 standard).
maturityDate string(date-time) false The format of this date should follow the ISO 8601 Date Format standard YYYY-MM-DD.
nominalAmountPerUnit string false Must be expressed in the currency reported under field nominalAmountCurrency
fixedRate string false Expressed as a percentage (e.g. 7.0 means 7% and 0.3 means 0.3%).
floatingRateIndexISIN string false ISIN code (ISO 6166 standard)
floatingRateIndexName string false To be filled where no ISIN identifier exists.
floatingRateIndexNameType string false none
floatingRateIndexTerm string false The Term of the index is represented as a number of days, weeks, months or years. It is composed of a “Val” expressed in numeric value {INTEGER-3} and a “Unit” expressed in ‘DAYS’, ‘WEEK’, ‘MNTH’, ‘YEAR’.
floatingRateIndexPointSpread string false Number of basis points above or below the index used to calculate a price.
bondSeniority string false ‘SNDB’, ‘MZZD’, ‘SBOD’, ‘JUND’
expiryDate string(date-time) false The format of this date should follow the ISO 8601 Date Format standard YYYY-MM-DD.
priceMultiplier string false Number of units of the underlying instrument represented by a single derivative contract.
underlyingInstrumentISIN string false The ISO 6166 standard (ISIN) must be used as the instrument identifier
underlyingIssuer string false ISO 17442 LEI (Legal Entity Identifier) standard.
underlyingIndexName string false To be filled when the underlying is an index.
underlyingIndexNameType string false none
underlyingIndexTerm string false The Term of the index is represented as a number of days, weeks, months or years. It is composed of a “Val” expressed in numeric value {INTEGER-3} and a “Unit” expressed in ‘DAYS’, ‘WEEK’, ‘MNTH’, ‘YEAR’.
optionType string false ‘PUTO’, ‘CALL’, ‘OTHR’
strikePrice string false Where price is currently not available and pending, the component “No Price” should have the value ’PNDG’. Where strike price is not applicable the field shall not be populated.
strikePriceType string false none
strikePriceCurrency string false 3 letter currency code (ISO 4217 standard).
optionExerciseStyle string false ‘EURO’, ‘AMER’, ‘ASIA’, ‘BERM’, ‘OTHR’
settlementType string false ‘PHYS’, ‘CASH’, ‘OPTL’
baseProduct string false A code field identifying the base product for the underlying class.
subProduct string false A code field identifying the sub product for the underlying asset class.
furtherSubProduct string false A code field identifying the base product for the underlying class
transactionType string false ‘FUTR’, ‘OPTN’, ‘TAPO’, ‘SWAP’, ‘MINI’, ‘OTCT’, ‘ORIT’, ‘CRCK’, ‘DIFF’, ‘OTHR’
finalPriceType string false ‘ARGM’, ‘BLTC’, ‘EXOF’, ‘GBCL’, ‘IHSM’, ‘PLAT’, ‘OTHR’
referenceRate string false {INDEX} or {ALPHANUM-25}
referenceRateType string false none
irContractTerm string none The Term of the index is represented as a number of days, weeks, months or years. It is composed of a “Val” expressed in numeric value {INTEGER-3} and a “Unit” expressed in ‘DAYS’, ‘WEEK’, ‘MNTH’, ‘YEAR’.
irNotionalCurrency2 string false 3 letter currency code (ISO 4217 standard).
fixedRateLeg1 string false Expressed as a percentage (e.g. 7.0 means 7% and 0.3 means 0.3%).
fixedRateLeg2 string false Expressed as a percentage (e.g. 7.0 means 7% and 0.3 means 0.3%).
floatingRateLeg2 string false {INDEX} or {ALPHANUM-25}
floatingRateLeg2Type string false none
contractTermLeg2 string false The Term of the index is represented as a number of days, weeks, months or years. It is composed of a “Val” expressed in numeric value {INTEGER-3} and a “Unit” expressed in ‘DAYS’, ‘WEEK’, ‘MNTH’, ‘YEAR’.
fxNotionalCurrency2 string false 3 letter currency code (ISO 4217 standard).
fxType string false ‘ARGM’, ‘BLTC’, ‘EXOF’, ‘GBCL’, ‘IHSM’, ‘PLAT’, ‘OTHR’
source string false none

Example Response (JSON)

{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete Security

Example Request

# You can also use wget

curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/security/{securityid}'

DELETE https://dev.heliocor.com/blotter-api/api/static/security/{securityid}

Deletes a security

Deletes a security.

URL Parameters

Parameter In Type Required Description
securityid path string true Security id

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Search Securities

Example Request

# You can also use wget
    
    curl -X GET 
    --header 'Accept: application/json' 
    --header 'Authorization: Bearer TOKEN' 
    'https://dev.heliocor.com/blotter-api/api/static/security/search?search=string'
    

    

GET https://dev.heliocor.com/blotter-api/api/static/security/search

Searches securities

Searches securities by ISIN.

Parameters

Parameter Type Required Description
search string true Search criteria

Example Response (JSON)

{
      "securities": [
        {
          "identifier": "string",
          "externalId": "string",
          "isin": "string",
          "name": "string",
          "classification": "string",
          "commoditiesOrEmissionIndicator": true,
          "issuerIdCode": "string",
          "tradingVenueIdCode": "string",
          "shortName": "string",
          "requestForAdmissionToTradingIndicator": true,
          "admissionToTradingApprovalDate": "string",
          "admissionToTradingRequestDate": "string",
          "admissionToTradingDate": "string",
          "terminationDate": "string",
          "notionalCurrency1": "string",
          "nominalAmount": "string",
          "nominalAmountCurrency": "string",
          "maturityDate": "string",
          "nominalAmountPerUnit": "string",
          "fixedRate": "string",
          "floatingRateIndexISIN": "string",
          "floatingRateIndexName": "string",
          "floatingRateIndexNameType": "string",
          "floatingRateIndexTerm": "string",
          "floatingRateIndexPointSpread": "string",
          "bondSeniority": "string",
          "expiryDate": "string",
          "priceMultiplier": "string",
          "underlyingInstrumentISIN": "string",
          "underlyingIssuer": "string",
          "underlyingIndexName": "string",
          "underlyingIndexNameType": "string",
          "underlyingIndexTerm": "string",
          "optionType": "string",
          "strikePrice": "string",
          "strikePriceType": "string",
          "strikePriceCurrency": "string",
          "optionExerciseStyle": "string",
          "settlementType": "string",
          "baseProduct": "string",
          "subProduct": "string",
          "furtherSubProduct": "string",
          "transactionType": "string",
          "finalPriceType": "string",
          "referenceRate": "string",
          "referenceRateType": "string",
          "irContractTerm": "string",
          "irNominalCurrency2": "string",
          "fixedRateLeg1": "string",
          "fixedRateLeg2": "string",
          "floatingRateLeg2": "string",
          "floatingRateLeg2Type": "string",
          "contractTermLeg2": "string",
          "fxNominalCurrency2": "string",
          "fxType": "string",
          "source": "string",
          "timestamp": "string"
        }
      ]
    }
    
{
      "securities": [
        {
          "identifier": "string",
          "externalId": "string",
          "isin": "string",
          "name": "string",
          "classification": "string",
          "commoditiesOrEmissionIndicator": true,
          "issuerIdCode": "string",
          "tradingVenueIdCode": "string",
          "shortName": "string",
          "requestForAdmissionToTradingIndicator": true,
          "admissionToTradingApprovalDate": "string",
          "admissionToTradingRequestDate": "string",
          "admissionToTradingDate": "string",
          "terminationDate": "string",
          "notionalCurrency1": "string",
          "nominalAmount": "string",
          "nominalAmountCurrency": "string",
          "maturityDate": "string",
          "nominalAmountPerUnit": "string",
          "fixedRate": "string",
          "floatingRateIndexISIN": "string",
          "floatingRateIndexName": "string",
          "floatingRateIndexNameType": "string",
          "floatingRateIndexTerm": "string",
          "floatingRateIndexPointSpread": "string",
          "bondSeniority": "string",
          "expiryDate": "string",
          "priceMultiplier": "string",
          "underlyingInstrumentISIN": "string",
          "underlyingIssuer": "string",
          "underlyingIndexName": "string",
          "underlyingIndexNameType": "string",
          "underlyingIndexTerm": "string",
          "optionType": "string",
          "strikePrice": "string",
          "strikePriceType": "string",
          "strikePriceCurrency": "string",
          "optionExerciseStyle": "string",
          "settlementType": "string",
          "baseProduct": "string",
          "subProduct": "string",
          "furtherSubProduct": "string",
          "transactionType": "string",
          "finalPriceType": "string",
          "referenceRate": "string",
          "referenceRateType": "string",
          "irContractTerm": "string",
          "irNominalCurrency2": "string",
          "fixedRateLeg1": "string",
          "fixedRateLeg2": "string",
          "floatingRateLeg2": "string",
          "floatingRateLeg2Type": "string",
          "contractTermLeg2": "string",
          "fxNominalCurrency2": "string",
          "fxType": "string",
          "source": "string",
          "timestamp": "string"
        }
      ]
    }
    

Responses

Status Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get Securities

Example Request

# You can also use wget
        
        curl -X GET 
        --header 'Accept: application/json' 
        --header 'Authorization: Bearer TOKEN' 
        'https://dev.heliocor.com/blotter-api/api/static/security?first=0&max=50'
        

        

GET https://dev.heliocor.com/blotter-api/api/static/security

Returns the list of securities

Returns the list of securities.

Parameters

Parameter Type Required Description
first integer(int32) false First security (default is 0)
max integer(int32) false Max security (default is 50, max value is 100)

Example Response (JSON)

{
          "count": 0,
          "securities": [
            {
              "identifier": "string",
              "externalId": "string",
              "isin": "string",
              "name": "string",
              "classification": "string",
              "commoditiesOrEmissionIndicator": true,
              "issuerIdCode": "string",
              "tradingVenueIdCode": "string",
              "shortName": "string",
              "requestForAdmissionToTradingIndicator": true,
              "admissionToTradingApprovalDate": "string",
              "admissionToTradingRequestDate": "string",
              "admissionToTradingDate": "string",
              "terminationDate": "string",
              "notionalCurrency1": "string",
              "nominalAmount": "string",
              "nominalAmountCurrency": "string",
              "maturityDate": "string",
              "nominalAmountPerUnit": "string",
              "fixedRate": "string",
              "floatingRateIndexISIN": "string",
              "floatingRateIndexName": "string",
              "floatingRateIndexNameType": "string",
              "floatingRateIndexTerm": "string",
              "floatingRateIndexPointSpread": "string",
              "bondSeniority": "string",
              "expiryDate": "string",
              "priceMultiplier": "string",
              "underlyingInstrumentISIN": "string",
              "underlyingIssuer": "string",
              "underlyingIndexName": "string",
              "underlyingIndexNameType": "string",
              "underlyingIndexTerm": "string",
              "optionType": "string",
              "strikePrice": "string",
              "strikePriceType": "string",
              "strikePriceCurrency": "string",
              "optionExerciseStyle": "string",
              "settlementType": "string",
              "baseProduct": "string",
              "subProduct": "string",
              "furtherSubProduct": "string",
              "transactionType": "string",
              "finalPriceType": "string",
              "referenceRate": "string",
              "referenceRateType": "string",
              "irContractTerm": "string",
              "irNominalCurrency2": "string",
              "fixedRateLeg1": "string",
              "fixedRateLeg2": "string",
              "floatingRateLeg2": "string",
              "floatingRateLeg2Type": "string",
              "contractTermLeg2": "string",
              "fxNominalCurrency2": "string",
              "fxType": "string",
              "source": "string",
              "timestamp": "string"
            }
          ]
        }
        
{
          "count": 0,
          "securities": [
            {
              "identifier": "string",
              "externalId": "string",
              "isin": "string",
              "name": "string",
              "classification": "string",
              "commoditiesOrEmissionIndicator": true,
              "issuerIdCode": "string",
              "tradingVenueIdCode": "string",
              "shortName": "string",
              "requestForAdmissionToTradingIndicator": true,
              "admissionToTradingApprovalDate": "string",
              "admissionToTradingRequestDate": "string",
              "admissionToTradingDate": "string",
              "terminationDate": "string",
              "notionalCurrency1": "string",
              "nominalAmount": "string",
              "nominalAmountCurrency": "string",
              "maturityDate": "string",
              "nominalAmountPerUnit": "string",
              "fixedRate": "string",
              "floatingRateIndexISIN": "string",
              "floatingRateIndexName": "string",
              "floatingRateIndexNameType": "string",
              "floatingRateIndexTerm": "string",
              "floatingRateIndexPointSpread": "string",
              "bondSeniority": "string",
              "expiryDate": "string",
              "priceMultiplier": "string",
              "underlyingInstrumentISIN": "string",
              "underlyingIssuer": "string",
              "underlyingIndexName": "string",
              "underlyingIndexNameType": "string",
              "underlyingIndexTerm": "string",
              "optionType": "string",
              "strikePrice": "string",
              "strikePriceType": "string",
              "strikePriceCurrency": "string",
              "optionExerciseStyle": "string",
              "settlementType": "string",
              "baseProduct": "string",
              "subProduct": "string",
              "furtherSubProduct": "string",
              "transactionType": "string",
              "finalPriceType": "string",
              "referenceRate": "string",
              "referenceRateType": "string",
              "irContractTerm": "string",
              "irNominalCurrency2": "string",
              "fixedRateLeg1": "string",
              "fixedRateLeg2": "string",
              "floatingRateLeg2": "string",
              "floatingRateLeg2Type": "string",
              "contractTermLeg2": "string",
              "fxNominalCurrency2": "string",
              "fxType": "string",
              "source": "string",
              "timestamp": "string"
            }
          ]
        }
        

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Add Security

Example Request

# You can also use wget
    
    curl -X POST 
    --header 'Content-Type: application/json' 
    --header 'Accept: application/json' 
    --header 'Authorization: Bearer TOKEN' -d '{
      "externalId": "string",
      "isin": "string",
      "name": "string",
      "classification": "string",
      "commoditiesOrEmissionIndicator": true,
      "issuerIdCode": "string",
      "tradingVenueIdCode": "string",
      "shortName": "string",
      "requestForAdmissionToTradingIndicator": true,
      "admissionToTradingApprovalDate": "2018-10-08T21:49:55.551Z",
      "admissionToTradingRequestDate": "2018-10-08T21:49:55.551Z",
      "admissionToTradingDate": "2018-10-08T21:49:55.551Z",
      "terminationDate": "2018-10-08T21:49:55.551Z",
      "notionalCurrency1": "string",
      "nominalAmount": "string",
      "nominalAmountCurrency": "string",
      "maturityDate": "2018-10-08T21:49:55.551Z",
      "nominalAmountPerUnit": "string",
      "fixedRate": "string",
      "floatingRateIndexISIN": "string",
      "floatingRateIndexName": "string",
      "floatingRateIndexNameType": "string",
      "floatingRateIndexTerm": "string",
      "floatingRateIndexPointSpread": "string",
      "bondSeniority": "string",
      "expiryDate": "2018-10-08T21:49:55.551Z",
      "priceMultiplier": "string",
      "underlyingInstrumentISIN": "string",
      "underlyingIssuer": "string",
      "underlyingIndexName": "string",
      "underlyingIndexNameType": "string",
      "underlyingIndexTerm": "string",
      "optionType": "string",
      "strikePrice": "string",
      "strikePriceType": "string",
      "strikePriceCurrency": "string",
      "optionExerciseStyle": "string",
      "settlementType": "string",
      "baseProduct": "string",
      "subProduct": "string",
      "furtherSubProduct": "string",
      "transactionType": "string",
      "finalPriceType": "string",
      "referenceRate": "string",
      "referenceRateType": "string",
      "irContractTerm": "string",
      "irNotionalCurrency2": "string",
      "fixedRateLeg1": "string",
      "fixedRateLeg2": "string",
      "floatingRateLeg2": "string",
      "floatingRateLeg2Type": "string",
      "contractTermLeg2": "string",
      "fxNotionalCurrency2": "string",
      "fxType": "string",
      "source": "string"
    }' 'https://dev.heliocor.com/blotter-api/api/static/security'
    
{
      "externalId": "string",
      "isin": "string",
      "name": "string",
      "classification": "string",
      "commoditiesOrEmissionIndicator": true,
      "issuerIdCode": "string",
      "tradingVenueIdCode": "string",
      "shortName": "string",
      "requestForAdmissionToTradingIndicator": true,
      "admissionToTradingApprovalDate": "2018-10-08T21:49:55.551Z",
      "admissionToTradingRequestDate": "2018-10-08T21:49:55.551Z",
      "admissionToTradingDate": "2018-10-08T21:49:55.551Z",
      "terminationDate": "2018-10-08T21:49:55.551Z",
      "notionalCurrency1": "string",
      "nominalAmount": "string",
      "nominalAmountCurrency": "string",
      "maturityDate": "2018-10-08T21:49:55.551Z",
      "nominalAmountPerUnit": "string",
      "fixedRate": "string",
      "floatingRateIndexISIN": "string",
      "floatingRateIndexName": "string",
      "floatingRateIndexNameType": "string",
      "floatingRateIndexTerm": "string",
      "floatingRateIndexPointSpread": "string",
      "bondSeniority": "string",
      "expiryDate": "2018-10-08T21:49:55.551Z",
      "priceMultiplier": "string",
      "underlyingInstrumentISIN": "string",
      "underlyingIssuer": "string",
      "underlyingIndexName": "string",
      "underlyingIndexNameType": "string",
      "underlyingIndexTerm": "string",
      "optionType": "string",
      "strikePrice": "string",
      "strikePriceType": "string",
      "strikePriceCurrency": "string",
      "optionExerciseStyle": "string",
      "settlementType": "string",
      "baseProduct": "string",
      "subProduct": "string",
      "furtherSubProduct": "string",
      "transactionType": "string",
      "finalPriceType": "string",
      "referenceRate": "string",
      "referenceRateType": "string",
      "irContractTerm": "string",
      "irNotionalCurrency2": "string",
      "fixedRateLeg1": "string",
      "fixedRateLeg2": "string",
      "floatingRateLeg2": "string",
      "floatingRateLeg2Type": "string",
      "contractTermLeg2": "string",
      "fxNotionalCurrency2": "string",
      "fxType": "string",
      "source": "string"
    }
    

POST https://dev.heliocor.com/blotter-api/api/static/security

Adds a security

Adds a security.

Parameters

Name Type Required Description
externalId string false none
isin string false ISIN code (ISO 6166 standard)
name string false The character set used should be UTF-8
classification string false CFI code (ISO 10962 standard)
commoditiesOrEmissionIndicator boolean false ’True’, ‘False’
issuerIdCode string false LEI code (ISO 17442 standard)
tradingVenueIdCode string false MIC code (ISO 10383 standard)
shortName string false FISN code (ISO 18774 standard)
requestForAdmissionToTradingIndicator boolean false ’True’, ‘False’
admissionToTradingApprovalDate string(date-time) false The date should be sent in the ISO 8601 date format standard YYYY-MM-DDThh:mm:ss.ddddddZ. Dates and times must be reported in UTC.
admissionToTradingRequestDate string(date-time) false The date should be sent in the ISO 8601 date format standard YYYY-MM-DDThh:mm:ss.ddddddZ.Dates and times shall be reported in UTC.
admissionToTradingDate string(date-time) false The date should be sent in the ISO 8601 date format standard YYYY-MM-DDThh:mm:ss.ddddddZ.Dates and times shall be reported in UTC.
terminationDate string(date-time) false The date should be sent in the ISO 8601 date format standard YYYY-MM-DDThh:mm:ss.ddddddZ. Dates and times shall be reported in UTC.
notionalCurrency1 string false 3 letter currency code (ISO 4217 standard).
nominalAmount string false Must be expressed in the currency reported under field nominalAmountCurrency
nominalAmountCurrency string false 3 letter currency code (ISO 4217 standard).
maturityDate string(date-time) false The format of this date should follow the ISO 8601 Date Format standard YYYY-MM-DD.
nominalAmountPerUnit string false Must be expressed in the currency reported under field nominalAmountCurrency
fixedRate string false Expressed as a percentage (e.g. 7.0 means 7% and 0.3 means 0.3%).
floatingRateIndexISIN string false ISIN code (ISO 6166 standard)
floatingRateIndexName string false To be filled where no ISIN identifier exists.
floatingRateIndexNameType string false none
floatingRateIndexTerm string false The Term of the index is represented as a number of days, weeks, months or years. It is composed of a “Val” expressed in numeric value {INTEGER-3} and a “Unit” expressed in ‘DAYS’, ‘WEEK’, ‘MNTH’, ‘YEAR’.
floatingRateIndexPointSpread string false Number of basis points above or below the index used to calculate a price.
bondSeniority string false ‘SNDB’, ‘MZZD’, ‘SBOD’, ‘JUND’
expiryDate string(date-time) false The format of this date should follow the ISO 8601 Date Format standard YYYY-MM-DD.
priceMultiplier string false Number of units of the underlying instrument represented by a single derivative contract.
underlyingInstrumentISIN string false The ISO 6166 standard (ISIN) must be used as the instrument identifier
underlyingIssuer string false ISO 17442 LEI (Legal Entity Identifier) standard.
underlyingIndexName string false To be filled when the underlying is an index.
underlyingIndexNameType string false none
underlyingIndexTerm string false The Term of the index is represented as a number of days, weeks, months or years. It is composed of a “Val” expressed in numeric value {INTEGER-3} and a “Unit” expressed in ‘DAYS’, ‘WEEK’, ‘MNTH’, ‘YEAR’.
optionType string false ‘PUTO’, ‘CALL’, ‘OTHR’
strikePrice string false Where price is currently not available and pending, the component “No Price” should have the value ’PNDG’. Where strike price is not applicable the field shall not be populated.
strikePriceType string false none
strikePriceCurrency string false 3 letter currency code (ISO 4217 standard).
optionExerciseStyle string false ‘EURO’, ‘AMER’, ‘ASIA’, ‘BERM’, ‘OTHR’
settlementType string false ‘PHYS’, ‘CASH’, ‘OPTL’
baseProduct string false A code field identifying the base product for the underlying class.
subProduct string false A code field identifying the sub product for the underlying asset class.
furtherSubProduct string false A code field identifying the base product for the underlying class
transactionType string false ‘FUTR’, ‘OPTN’, ‘TAPO’, ‘SWAP’, ‘MINI’, ‘OTCT’, ‘ORIT’, ‘CRCK’, ‘DIFF’, ‘OTHR’
finalPriceType string false ‘ARGM’, ‘BLTC’, ‘EXOF’, ‘GBCL’, ‘IHSM’, ‘PLAT’, ‘OTHR’
referenceRate string false {INDEX} or {ALPHANUM-25}
referenceRateType string false none
irContractTerm string none The Term of the index is represented as a number of days, weeks, months or years. It is composed of a “Val” expressed in numeric value {INTEGER-3} and a “Unit” expressed in ‘DAYS’, ‘WEEK’, ‘MNTH’, ‘YEAR’.
irNotionalCurrency2 string false 3 letter currency code (ISO 4217 standard).
fixedRateLeg1 string false Expressed as a percentage (e.g. 7.0 means 7% and 0.3 means 0.3%).
fixedRateLeg2 string false Expressed as a percentage (e.g. 7.0 means 7% and 0.3 means 0.3%).
floatingRateLeg2 string false {INDEX} or {ALPHANUM-25}
floatingRateLeg2Type string false none
contractTermLeg2 string false The Term of the index is represented as a number of days, weeks, months or years. It is composed of a “Val” expressed in numeric value {INTEGER-3} and a “Unit” expressed in ‘DAYS’, ‘WEEK’, ‘MNTH’, ‘YEAR’.
fxNotionalCurrency2 string false 3 letter currency code (ISO 4217 standard).
fxType string false ‘ARGM’, ‘BLTC’, ‘EXOF’, ‘GBCL’, ‘IHSM’, ‘PLAT’, ‘OTHR’
source string false none

Example Response (JSON)

{
      "security": {
        "identifier": "string",
        "externalId": "string",
        "isin": "string",
        "name": "string",
        "classification": "string",
        "commoditiesOrEmissionIndicator": true,
        "issuerIdCode": "string",
        "tradingVenueIdCode": "string",
        "shortName": "string",
        "requestForAdmissionToTradingIndicator": true,
        "admissionToTradingApprovalDate": "string",
        "admissionToTradingRequestDate": "string",
        "admissionToTradingDate": "string",
        "terminationDate": "string",
        "notionalCurrency1": "string",
        "nominalAmount": "string",
        "nominalAmountCurrency": "string",
        "maturityDate": "string",
        "nominalAmountPerUnit": "string",
        "fixedRate": "string",
        "floatingRateIndexISIN": "string",
        "floatingRateIndexName": "string",
        "floatingRateIndexNameType": "string",
        "floatingRateIndexTerm": "string",
        "floatingRateIndexPointSpread": "string",
        "bondSeniority": "string",
        "expiryDate": "string",
        "priceMultiplier": "string",
        "underlyingInstrumentISIN": "string",
        "underlyingIssuer": "string",
        "underlyingIndexName": "string",
        "underlyingIndexNameType": "string",
        "underlyingIndexTerm": "string",
        "optionType": "string",
        "strikePrice": "string",
        "strikePriceType": "string",
        "strikePriceCurrency": "string",
        "optionExerciseStyle": "string",
        "settlementType": "string",
        "baseProduct": "string",
        "subProduct": "string",
        "furtherSubProduct": "string",
        "transactionType": "string",
        "finalPriceType": "string",
        "referenceRate": "string",
        "referenceRateType": "string",
        "irContractTerm": "string",
        "irNominalCurrency2": "string",
        "fixedRateLeg1": "string",
        "fixedRateLeg2": "string",
        "floatingRateLeg2": "string",
        "floatingRateLeg2Type": "string",
        "contractTermLeg2": "string",
        "fxNominalCurrency2": "string",
        "fxType": "string",
        "source": "string",
        "timestamp": "string"
      }
    }
    
{
      "security": {
        "identifier": "string",
        "externalId": "string",
        "isin": "string",
        "name": "string",
        "classification": "string",
        "commoditiesOrEmissionIndicator": true,
        "issuerIdCode": "string",
        "tradingVenueIdCode": "string",
        "shortName": "string",
        "requestForAdmissionToTradingIndicator": true,
        "admissionToTradingApprovalDate": "string",
        "admissionToTradingRequestDate": "string",
        "admissionToTradingDate": "string",
        "terminationDate": "string",
        "notionalCurrency1": "string",
        "nominalAmount": "string",
        "nominalAmountCurrency": "string",
        "maturityDate": "string",
        "nominalAmountPerUnit": "string",
        "fixedRate": "string",
        "floatingRateIndexISIN": "string",
        "floatingRateIndexName": "string",
        "floatingRateIndexNameType": "string",
        "floatingRateIndexTerm": "string",
        "floatingRateIndexPointSpread": "string",
        "bondSeniority": "string",
        "expiryDate": "string",
        "priceMultiplier": "string",
        "underlyingInstrumentISIN": "string",
        "underlyingIssuer": "string",
        "underlyingIndexName": "string",
        "underlyingIndexNameType": "string",
        "underlyingIndexTerm": "string",
        "optionType": "string",
        "strikePrice": "string",
        "strikePriceType": "string",
        "strikePriceCurrency": "string",
        "optionExerciseStyle": "string",
        "settlementType": "string",
        "baseProduct": "string",
        "subProduct": "string",
        "furtherSubProduct": "string",
        "transactionType": "string",
        "finalPriceType": "string",
        "referenceRate": "string",
        "referenceRateType": "string",
        "irContractTerm": "string",
        "irNominalCurrency2": "string",
        "fixedRateLeg1": "string",
        "fixedRateLeg2": "string",
        "floatingRateLeg2": "string",
        "floatingRateLeg2Type": "string",
        "contractTermLeg2": "string",
        "fxNominalCurrency2": "string",
        "fxType": "string",
        "source": "string",
        "timestamp": "string"
      }
    }
    

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

CounterParties

Get Counterparty

Example Request

# You can also use wget

curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}'

GET https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}

Returns a counterparty

Returns a counterparty.

Parameters

Parameter Type Required Description
counterpartyid string true Counterparty id

Example Response (JSON)

{
  "counterparty": {
    "identifier": "string",
    "externalId": "string",
    "parentExternalId": "string",
    "lei": "string",
    "name": "string",
    "shortName": "string",
    "source": "string",
    "timestamp": "string"
  }
}
{
  "counterparty": {
    "identifier": "string",
    "externalId": "string",
    "parentExternalId": "string",
    "lei": "string",
    "name": "string",
    "shortName": "string",
    "source": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update Counterparty

Example Request

# You can also use wget

curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "externalId": "string",
  "parentExternalId": "string",
  "lei": "string",
  "name": "string",
  "shortName": "string",
  "source": "string"
}' 'https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}'
{
  "externalId": "string",
  "parentExternalId": "string",
  "lei": "string",
  "name": "string",
  "shortName": "string",
  "source": "string"
}

POST https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}

Updates a counterparty

Updates a counterparty.

URL Parameters

Parameter Type Required Description
counterpartyid path string true

Parameters

Name Type Required Description
externalId string false Counterparty ID
parentExternalId string false Counterparty Parent ID
lei string false Counterparty LEI number
name string false Counterparty Name
shortName string false Counterparty Short Name
source string false none

Example Response (JSON)

{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete Counterparty

Example Request

# You can also use wget

curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN'
'https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}'

DELETE https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}

Deletes a counterparty

Deletes a counterparty.

Parameters

Parameter In Type Required Description
counterpartyid path string true Counterparty id

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Search CounterpartyTraders

Example Request

# You can also use wget

curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN'
'https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader/search?search=string'

GET https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader/search

Searches counterparty traders

Searches counterparty traders.

Parameters

Parameter Type Required Description
counterpartyid string true Counterparty id
search string true Search criteria

Example Response (JSON)

{
  "traders": [
    {
      "identifier": "string",
      "name": "string",
      "phone": "string",
      "email": "string",
      "bloombergId": "string",
      "reutersId": "string",
      "timestamp": "string"
    }
  ]
}
{
  "traders": [
    {
      "identifier": "string",
      "name": "string",
      "phone": "string",
      "email": "string",
      "bloombergId": "string",
      "reutersId": "string",
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get CounterpartyTrader

Example Request

# You can also use wget

curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader/{counterpartytraderid}'

GET https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader/{counterpartytraderid}

Returns a counterparty trader

Returns a counterparty trader.

Parameters

Parameter Type Required Description
counterpartyid string true Counterparty id
counterpartytraderid string true Counterparty trader id

Example Response (JSON)

{
  "trader": {
    "identifier": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "bloombergId": "string",
    "reutersId": "string",
    "timestamp": "string"
  }
}
{
  "trader": {
    "identifier": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "bloombergId": "string",
    "reutersId": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update CounterpartyTrader

Example Request

# You can also use wget

curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "name": "string",
  "email": "string",
  "phone": "string",
  "bloombergId": "string",
  "reutersId": "string"
}' 'https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader/{counterpartytraderid}'
{
  "name": "string",
  "email": "string",
  "phone": "string",
  "bloombergId": "string",
  "reutersId": "string"
}

POST https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader/{counterpartytraderid}

Updates a counterparty trader

Updates a counterparty trader.

{
  "name": "string",
  "email": "string",
  "phone": "string",
  "bloombergId": "string",
  "reutersId": "string"
}
{
  "name": "string",
  "email": "string",
  "phone": "string",
  "bloombergId": "string",
  "reutersId": "string"
}

URL Parameters

Parameter Type Required Description
counterpartyid string true Counterparty id
counterpartytraderid string true Counterparty trader id

Parameters

Name Type Required Description
name string false Trader name
email string false Trader email
phone string false Trader phone number
bloombergId string false Trader Bloomberg ID
reutersId string false Trader Reuters ID

Example Response (JSON)

{}
{}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete CounterpartyTrader

Example Request

# You can also use wget

curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader/{counterpartytraderid}'

DELETE https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader/{counterpartytraderid}

Deletes a counterparty trader

Deletes a counterparty trader.

Parameters

Parameter Type Required Description
counterpartyid string true Counterparty id
counterpartytraderid string true Counterparty trader id

Example Response (JSON)

{}
{}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get CounterpartyTraders

Example Request

# You can also use wget

curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader?first=0&max=50'

GET https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader

Returns the list of counterparty traders

Returns the list of counterparty traders.

Parameters

Parameter Type Required Description
counterpartyid string true Counterparty id
first integer(int32) false First trader (default is 0)
max integer(int32) false Max traders (default is 50, max value is 100)

Example Response (JSON)

{
  "count": 0,
  "traders": [
    {
      "identifier": "string",
      "name": "string",
      "phone": "string",
      "email": "string",
      "bloombergId": "string",
      "reutersId": "string",
      "timestamp": "string"
    }
  ]
}
{
  "count": 0,
  "traders": [
    {
      "identifier": "string",
      "name": "string",
      "phone": "string",
      "email": "string",
      "bloombergId": "string",
      "reutersId": "string",
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Add CounterpartyTrader

Example Request

# You can also use wget

curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "name": "string",
  "email": "string",
  "phone": "string",
  "bloombergId": "string",
  "reutersId": "string"
}' 'https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader'
{
  "name": "string",
  "email": "string",
  "phone": "string",
  "bloombergId": "string",
  "reutersId": "string"
}

POST https://dev.heliocor.com/blotter-api/api/static/counterparty/{counterpartyid}/trader

Adds a counterparty trader

Adds a counterparty trader.

URL Parameters

Parameter In Type Required Description
counterpartyid path string true Counterparty id

Parameters

Name Type Required Description
name string false Trader name
email string false Trader email
phone string false Trader phone number
bloombergId string false Trader Bloomberg ID
reutersId string false Trader Reuters ID

Example Response (JSON)

{
  "trader": {
    "identifier": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "bloombergId": "string",
    "reutersId": "string",
    "timestamp": "string"
  }
}
{
  "trader": {
    "identifier": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "bloombergId": "string",
    "reutersId": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Search Counterparties

Example Request

# You can also use wget

curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/counterparty/search?search=string'

GET https://dev.heliocor.com/blotter-api/api/static/counterparty/search

Searches counterparties

Searches counterparties by LEI and name.

Parameters

Parameter Type Required Description
search string true Search criteria

Example Response (JSON)

{
  "counterparties": [
    {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    }
  ]
}
{
  "counterparties": [
    {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get Counterparties

Example Request

# You can also use wget

curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/counterparty?first=0&max=50'

GET https://dev.heliocor.com/blotter-api/api/static/counterparty

Returns the list of counterparties

Returns the list of counterparties.

Parameters

Parameter Type Required Description
first integer(int32) false First counterparty (default is 0)
max integer(int32) false Max counterparty (default is 50, max value is 100)

Example Response (JSON)

{
  "count": 0,
  "counterparties": [
    {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    }
  ]
}
{
  "count": 0,
  "counterparties": [
    {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Add Counterparty

Example Request

# You can also use wget

curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "externalId": "string",
  "parentExternalId": "string",
  "lei": "string",
  "name": "string",
  "shortName": "string",
  "source": "string"
}' 'https://dev.heliocor.com/blotter-api/api/static/counterparty'
{
  "externalId": "string",
  "parentExternalId": "string",
  "lei": "string",
  "name": "string",
  "shortName": "string",
  "source": "string"
}

POST https://dev.heliocor.com/blotter-api/api/static/counterparty

Adds a counterparty

Adds a counterparty.

Parameters

Name Type Required Description
externalId string false Counterparty ID
parentExternalId string false Counterparty Parent ID
lei string false Counterparty LEI number
name string false Counterparty Name
shortName string false Counterparty Short Name
source string false none

Example Response (JSON)

{
  "counterparty": {
    "identifier": "string",
    "externalId": "string",
    "parentExternalId": "string",
    "lei": "string",
    "name": "string",
    "shortName": "string",
    "source": "string",
    "timestamp": "string"
  }
}
{
  "counterparty": {
    "identifier": "string",
    "externalId": "string",
    "parentExternalId": "string",
    "lei": "string",
    "name": "string",
    "shortName": "string",
    "source": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

trade

Get All Trades

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/trade?first=0&max=50'

GET https://dev.heliocor.com/blotter-api/api/static/trade

Returns the list of trades

Returns the list of trades.

Parameters

Parameter Type Required Description
first integer(int32) false First trade (default is 0)
max integer(int32) false Max trade (default is 50, max value is 100)

Example Response (JSON)

{
  "count": 0,
  "trades": [
    {
      "identifier": "string",
      "externalId": "string",
      "transactionReferenceNumber": "string",
      "tradingVenueTransactionIdCode": "string",
      "buyer": {
        "identifier": "string",
        "externalId": "string",
        "parentExternalId": "string",
        "lei": "string",
        "name": "string",
        "shortName": "string",
        "source": "string",
        "timestamp": "string"
      },
      "seller": {
        "identifier": "string",
        "externalId": "string",
        "parentExternalId": "string",
        "lei": "string",
        "name": "string",
        "shortName": "string",
        "source": "string",
        "timestamp": "string"
      },
      "tradingDateAndTime": "string",
      "tradingCapacity": "string",
      "quantity": "string",
      "quantityFormat": "string",
      "quantityCurrency": "string",
      "derivativeNotional": "string",
      "price": "string",
      "priceFormat": "string",
      "priceCurrency": "string",
      "netAmount": "string",
      "tradingVenueIdCode": "string",
      "countryOfBranchMembership": "string",
      "upFrontPayment": "string",
      "upFrontPaymentCurrency": "string",
      "security": {
        "identifier": "string",
        "externalId": "string",
        "isin": "string",
        "name": "string",
        "classification": "string",
        "commoditiesOrEmissionIndicator": true,
        "issuerIdCode": "string",
        "tradingVenueIdCode": "string",
        "shortName": "string",
        "requestForAdmissionToTradingIndicator": true,
        "admissionToTradingApprovalDate": "string",
        "admissionToTradingRequestDate": "string",
        "admissionToTradingDate": "string",
        "terminationDate": "string",
        "notionalCurrency1": "string",
        "nominalAmount": "string",
        "nominalAmountCurrency": "string",
        "maturityDate": "string",
        "nominalAmountPerUnit": "string",
        "fixedRate": "string",
        "floatingRateIndexISIN": "string",
        "floatingRateIndexName": "string",
        "floatingRateIndexNameType": "string",
        "floatingRateIndexTerm": "string",
        "floatingRateIndexPointSpread": "string",
        "bondSeniority": "string",
        "expiryDate": "string",
        "priceMultiplier": "string",
        "underlyingInstrumentISIN": "string",
        "underlyingIssuer": "string",
        "underlyingIndexName": "string",
        "underlyingIndexNameType": "string",
        "underlyingIndexTerm": "string",
        "optionType": "string",
        "strikePrice": "string",
        "strikePriceType": "string",
        "strikePriceCurrency": "string",
        "optionExerciseStyle": "string",
        "settlementType": "string",
        "baseProduct": "string",
        "subProduct": "string",
        "furtherSubProduct": "string",
        "transactionType": "string",
        "finalPriceType": "string",
        "referenceRate": "string",
        "referenceRateType": "string",
        "irContractTerm": "string",
        "irNominalCurrency2": "string",
        "fixedRateLeg1": "string",
        "fixedRateLeg2": "string",
        "floatingRateLeg2": "string",
        "floatingRateLeg2Type": "string",
        "contractTermLeg2": "string",
        "fxNominalCurrency2": "string",
        "fxType": "string",
        "source": "string",
        "timestamp": "string"
      },
      "source": "string",
      "timestamp": "string"
    }
  ]
}
{
  "count": 0,
  "trades": [
    {
      "identifier": "string",
      "externalId": "string",
      "transactionReferenceNumber": "string",
      "tradingVenueTransactionIdCode": "string",
      "buyer": {
        "identifier": "string",
        "externalId": "string",
        "parentExternalId": "string",
        "lei": "string",
        "name": "string",
        "shortName": "string",
        "source": "string",
        "timestamp": "string"
      },
      "seller": {
        "identifier": "string",
        "externalId": "string",
        "parentExternalId": "string",
        "lei": "string",
        "name": "string",
        "shortName": "string",
        "source": "string",
        "timestamp": "string"
      },
      "tradingDateAndTime": "string",
      "tradingCapacity": "string",
      "quantity": "string",
      "quantityFormat": "string",
      "quantityCurrency": "string",
      "derivativeNotional": "string",
      "price": "string",
      "priceFormat": "string",
      "priceCurrency": "string",
      "netAmount": "string",
      "tradingVenueIdCode": "string",
      "countryOfBranchMembership": "string",
      "upFrontPayment": "string",
      "upFrontPaymentCurrency": "string",
      "security": {
        "identifier": "string",
        "externalId": "string",
        "isin": "string",
        "name": "string",
        "classification": "string",
        "commoditiesOrEmissionIndicator": true,
        "issuerIdCode": "string",
        "tradingVenueIdCode": "string",
        "shortName": "string",
        "requestForAdmissionToTradingIndicator": true,
        "admissionToTradingApprovalDate": "string",
        "admissionToTradingRequestDate": "string",
        "admissionToTradingDate": "string",
        "terminationDate": "string",
        "notionalCurrency1": "string",
        "nominalAmount": "string",
        "nominalAmountCurrency": "string",
        "maturityDate": "string",
        "nominalAmountPerUnit": "string",
        "fixedRate": "string",
        "floatingRateIndexISIN": "string",
        "floatingRateIndexName": "string",
        "floatingRateIndexNameType": "string",
        "floatingRateIndexTerm": "string",
        "floatingRateIndexPointSpread": "string",
        "bondSeniority": "string",
        "expiryDate": "string",
        "priceMultiplier": "string",
        "underlyingInstrumentISIN": "string",
        "underlyingIssuer": "string",
        "underlyingIndexName": "string",
        "underlyingIndexNameType": "string",
        "underlyingIndexTerm": "string",
        "optionType": "string",
        "strikePrice": "string",
        "strikePriceType": "string",
        "strikePriceCurrency": "string",
        "optionExerciseStyle": "string",
        "settlementType": "string",
        "baseProduct": "string",
        "subProduct": "string",
        "furtherSubProduct": "string",
        "transactionType": "string",
        "finalPriceType": "string",
        "referenceRate": "string",
        "referenceRateType": "string",
        "irContractTerm": "string",
        "irNominalCurrency2": "string",
        "fixedRateLeg1": "string",
        "fixedRateLeg2": "string",
        "floatingRateLeg2": "string",
        "floatingRateLeg2Type": "string",
        "contractTermLeg2": "string",
        "fxNominalCurrency2": "string",
        "fxType": "string",
        "source": "string",
        "timestamp": "string"
      },
      "source": "string",
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Add a Trade

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "externalId": "string",
  "transactionReferenceNumber": "string",
  "tradingVenueTransactionIdCode": "string",
  "buyerid": "string",
  "sellerid": "string",
  "tradingDateAndTime": "string",
  "tradingCapacity": "string",
  "quantity": "string",
  "quantityFormat": "string",
  "quantityCurrency": "string",
  "derivativeNotional": "string",
  "price": "string",
  "priceFormat": "string",
  "priceCurrency": "string",
  "netAmount": "string",
  "tradingVenueIdCode": "string",
  "countryOfBranchMembership": "string",
  "upFrontPayment": "string",
  "upFrontPaymentCurrency": "string",
  "securityid": "string",
  "source": "string"
}' 'https://dev.heliocor.com/blotter-api/api/static/trade'
{
  "externalId": "string",
  "transactionReferenceNumber": "string",
  "tradingVenueTransactionIdCode": "string",
  "buyerid": "string",
  "sellerid": "string",
  "tradingDateAndTime": "string",
  "tradingCapacity": "string",
  "quantity": "string",
  "quantityFormat": "string",
  "quantityCurrency": "string",
  "derivativeNotional": "string",
  "price": "string",
  "priceFormat": "string",
  "priceCurrency": "string",
  "netAmount": "string",
  "tradingVenueIdCode": "string",
  "countryOfBranchMembership": "string",
  "upFrontPayment": "string",
  "upFrontPaymentCurrency": "string",
  "securityid": "string",
  "source": "string"
}

POST https://dev.heliocor.com/blotter-api/api/static/trade

Adds a trade

Adds a trade.

Parameters

Name Type Required Description
externalId string false External identifier
transactionReferenceNumber string false Identification number internal to the executing firm that is unique for each transaction submitted by the firm.
tradingVenueTransactionIdCode string false Identification number generated by trading venues and disseminated to both the buying and the selling parties.
buyerid string false ID of the Counterparty that buys the product.
sellerid string false ID of the Counterparty that sells the product.
tradingDateAndTime string false ISO 8601 date and time format
tradingCapacity string false 'OWN_ACCCOUNT', 'MATCHED_PRINCIPAL', 'ANY_OTHER'
quantity string false The number of units of the financial instrument, number of derivative contracts in the transaction, or the nominal or monetary value of the financial instrument.
quantityFormat string false none
quantityCurrency string false ISO 4217 Currency Code of the quantity if it is a monetary value
derivativeNotional string false 'INCREASE', 'DECREASE'
price string false 'PNDG' (Price pending), 'NOAP' (No price for transaction) or Decimal value
priceFormat string false none
priceCurrency string false ISO 4217 Currency Code of the price if it is a monetary value
netAmount string false The cash amount paid by the buyer of a debt instrument upon the settlement of the transaction.
tradingVenueIdCode string false ISO 10383 MIC of the venue where the trade is executed
countryOfBranchMembership string false ISO 3166 Country Code of the branch of the investment firm used to execute the transaction
upFrontPayment string false Monetary value of any up-front payment received or paid by the seller.
upFrontPaymentCurrency string false ISO 4217 Currency Code of the upFrontPayment
securityid string false ID of the Security the trade refers to.
source string false none

Example Response (JSON)

{
  "trade": {
    "identifier": "string",
    "externalId": "string",
    "transactionReferenceNumber": "string",
    "tradingVenueTransactionIdCode": "string",
    "buyer": {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    },
    "seller": {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    },
    "tradingDateAndTime": "string",
    "tradingCapacity": "string",
    "quantity": "string",
    "quantityFormat": "string",
    "quantityCurrency": "string",
    "derivativeNotional": "string",
    "price": "string",
    "priceFormat": "string",
    "priceCurrency": "string",
    "netAmount": "string",
    "tradingVenueIdCode": "string",
    "countryOfBranchMembership": "string",
    "upFrontPayment": "string",
    "upFrontPaymentCurrency": "string",
    "security": {
      "identifier": "string",
      "externalId": "string",
      "isin": "string",
      "name": "string",
      "classification": "string",
      "commoditiesOrEmissionIndicator": true,
      "issuerIdCode": "string",
      "tradingVenueIdCode": "string",
      "shortName": "string",
      "requestForAdmissionToTradingIndicator": true,
      "admissionToTradingApprovalDate": "string",
      "admissionToTradingRequestDate": "string",
      "admissionToTradingDate": "string",
      "terminationDate": "string",
      "notionalCurrency1": "string",
      "nominalAmount": "string",
      "nominalAmountCurrency": "string",
      "maturityDate": "string",
      "nominalAmountPerUnit": "string",
      "fixedRate": "string",
      "floatingRateIndexISIN": "string",
      "floatingRateIndexName": "string",
      "floatingRateIndexNameType": "string",
      "floatingRateIndexTerm": "string",
      "floatingRateIndexPointSpread": "string",
      "bondSeniority": "string",
      "expiryDate": "string",
      "priceMultiplier": "string",
      "underlyingInstrumentISIN": "string",
      "underlyingIssuer": "string",
      "underlyingIndexName": "string",
      "underlyingIndexNameType": "string",
      "underlyingIndexTerm": "string",
      "optionType": "string",
      "strikePrice": "string",
      "strikePriceType": "string",
      "strikePriceCurrency": "string",
      "optionExerciseStyle": "string",
      "settlementType": "string",
      "baseProduct": "string",
      "subProduct": "string",
      "furtherSubProduct": "string",
      "transactionType": "string",
      "finalPriceType": "string",
      "referenceRate": "string",
      "referenceRateType": "string",
      "irContractTerm": "string",
      "irNominalCurrency2": "string",
      "fixedRateLeg1": "string",
      "fixedRateLeg2": "string",
      "floatingRateLeg2": "string",
      "floatingRateLeg2Type": "string",
      "contractTermLeg2": "string",
      "fxNominalCurrency2": "string",
      "fxType": "string",
      "source": "string",
      "timestamp": "string"
    },
    "source": "string",
    "timestamp": "string"
  }
}
{
  "trade": {
    "identifier": "string",
    "externalId": "string",
    "transactionReferenceNumber": "string",
    "tradingVenueTransactionIdCode": "string",
    "buyer": {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    },
    "seller": {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    },
    "tradingDateAndTime": "string",
    "tradingCapacity": "string",
    "quantity": "string",
    "quantityFormat": "string",
    "quantityCurrency": "string",
    "derivativeNotional": "string",
    "price": "string",
    "priceFormat": "string",
    "priceCurrency": "string",
    "netAmount": "string",
    "tradingVenueIdCode": "string",
    "countryOfBranchMembership": "string",
    "upFrontPayment": "string",
    "upFrontPaymentCurrency": "string",
    "security": {
      "identifier": "string",
      "externalId": "string",
      "isin": "string",
      "name": "string",
      "classification": "string",
      "commoditiesOrEmissionIndicator": true,
      "issuerIdCode": "string",
      "tradingVenueIdCode": "string",
      "shortName": "string",
      "requestForAdmissionToTradingIndicator": true,
      "admissionToTradingApprovalDate": "string",
      "admissionToTradingRequestDate": "string",
      "admissionToTradingDate": "string",
      "terminationDate": "string",
      "notionalCurrency1": "string",
      "nominalAmount": "string",
      "nominalAmountCurrency": "string",
      "maturityDate": "string",
      "nominalAmountPerUnit": "string",
      "fixedRate": "string",
      "floatingRateIndexISIN": "string",
      "floatingRateIndexName": "string",
      "floatingRateIndexNameType": "string",
      "floatingRateIndexTerm": "string",
      "floatingRateIndexPointSpread": "string",
      "bondSeniority": "string",
      "expiryDate": "string",
      "priceMultiplier": "string",
      "underlyingInstrumentISIN": "string",
      "underlyingIssuer": "string",
      "underlyingIndexName": "string",
      "underlyingIndexNameType": "string",
      "underlyingIndexTerm": "string",
      "optionType": "string",
      "strikePrice": "string",
      "strikePriceType": "string",
      "strikePriceCurrency": "string",
      "optionExerciseStyle": "string",
      "settlementType": "string",
      "baseProduct": "string",
      "subProduct": "string",
      "furtherSubProduct": "string",
      "transactionType": "string",
      "finalPriceType": "string",
      "referenceRate": "string",
      "referenceRateType": "string",
      "irContractTerm": "string",
      "irNominalCurrency2": "string",
      "fixedRateLeg1": "string",
      "fixedRateLeg2": "string",
      "floatingRateLeg2": "string",
      "floatingRateLeg2Type": "string",
      "contractTermLeg2": "string",
      "fxNominalCurrency2": "string",
      "fxType": "string",
      "source": "string",
      "timestamp": "string"
    },
    "source": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get a Trade

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/trade/{tradeid}'

GET https://dev.heliocor.com/blotter-api/api/static/trade/{tradeid}

Returns a trade

Returns a trade.

Parameters

Parameter Type Required Description
tradeid string true Trade id

Example Response (JSON)

{
  "trade": {
    "identifier": "string",
    "externalId": "string",
    "transactionReferenceNumber": "string",
    "tradingVenueTransactionIdCode": "string",
    "buyer": {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    },
    "seller": {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    },
    "tradingDateAndTime": "string",
    "tradingCapacity": "string",
    "quantity": "string",
    "quantityFormat": "string",
    "quantityCurrency": "string",
    "derivativeNotional": "string",
    "price": "string",
    "priceFormat": "string",
    "priceCurrency": "string",
    "netAmount": "string",
    "tradingVenueIdCode": "string",
    "countryOfBranchMembership": "string",
    "upFrontPayment": "string",
    "upFrontPaymentCurrency": "string",
    "security": {
      "identifier": "string",
      "externalId": "string",
      "isin": "string",
      "name": "string",
      "classification": "string",
      "commoditiesOrEmissionIndicator": true,
      "issuerIdCode": "string",
      "tradingVenueIdCode": "string",
      "shortName": "string",
      "requestForAdmissionToTradingIndicator": true,
      "admissionToTradingApprovalDate": "string",
      "admissionToTradingRequestDate": "string",
      "admissionToTradingDate": "string",
      "terminationDate": "string",
      "notionalCurrency1": "string",
      "nominalAmount": "string",
      "nominalAmountCurrency": "string",
      "maturityDate": "string",
      "nominalAmountPerUnit": "string",
      "fixedRate": "string",
      "floatingRateIndexISIN": "string",
      "floatingRateIndexName": "string",
      "floatingRateIndexNameType": "string",
      "floatingRateIndexTerm": "string",
      "floatingRateIndexPointSpread": "string",
      "bondSeniority": "string",
      "expiryDate": "string",
      "priceMultiplier": "string",
      "underlyingInstrumentISIN": "string",
      "underlyingIssuer": "string",
      "underlyingIndexName": "string",
      "underlyingIndexNameType": "string",
      "underlyingIndexTerm": "string",
      "optionType": "string",
      "strikePrice": "string",
      "strikePriceType": "string",
      "strikePriceCurrency": "string",
      "optionExerciseStyle": "string",
      "settlementType": "string",
      "baseProduct": "string",
      "subProduct": "string",
      "furtherSubProduct": "string",
      "transactionType": "string",
      "finalPriceType": "string",
      "referenceRate": "string",
      "referenceRateType": "string",
      "irContractTerm": "string",
      "irNominalCurrency2": "string",
      "fixedRateLeg1": "string",
      "fixedRateLeg2": "string",
      "floatingRateLeg2": "string",
      "floatingRateLeg2Type": "string",
      "contractTermLeg2": "string",
      "fxNominalCurrency2": "string",
      "fxType": "string",
      "source": "string",
      "timestamp": "string"
    },
    "source": "string",
    "timestamp": "string"
  }
}
{
  "trade": {
    "identifier": "string",
    "externalId": "string",
    "transactionReferenceNumber": "string",
    "tradingVenueTransactionIdCode": "string",
    "buyer": {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    },
    "seller": {
      "identifier": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "lei": "string",
      "name": "string",
      "shortName": "string",
      "source": "string",
      "timestamp": "string"
    },
    "tradingDateAndTime": "string",
    "tradingCapacity": "string",
    "quantity": "string",
    "quantityFormat": "string",
    "quantityCurrency": "string",
    "derivativeNotional": "string",
    "price": "string",
    "priceFormat": "string",
    "priceCurrency": "string",
    "netAmount": "string",
    "tradingVenueIdCode": "string",
    "countryOfBranchMembership": "string",
    "upFrontPayment": "string",
    "upFrontPaymentCurrency": "string",
    "security": {
      "identifier": "string",
      "externalId": "string",
      "isin": "string",
      "name": "string",
      "classification": "string",
      "commoditiesOrEmissionIndicator": true,
      "issuerIdCode": "string",
      "tradingVenueIdCode": "string",
      "shortName": "string",
      "requestForAdmissionToTradingIndicator": true,
      "admissionToTradingApprovalDate": "string",
      "admissionToTradingRequestDate": "string",
      "admissionToTradingDate": "string",
      "terminationDate": "string",
      "notionalCurrency1": "string",
      "nominalAmount": "string",
      "nominalAmountCurrency": "string",
      "maturityDate": "string",
      "nominalAmountPerUnit": "string",
      "fixedRate": "string",
      "floatingRateIndexISIN": "string",
      "floatingRateIndexName": "string",
      "floatingRateIndexNameType": "string",
      "floatingRateIndexTerm": "string",
      "floatingRateIndexPointSpread": "string",
      "bondSeniority": "string",
      "expiryDate": "string",
      "priceMultiplier": "string",
      "underlyingInstrumentISIN": "string",
      "underlyingIssuer": "string",
      "underlyingIndexName": "string",
      "underlyingIndexNameType": "string",
      "underlyingIndexTerm": "string",
      "optionType": "string",
      "strikePrice": "string",
      "strikePriceType": "string",
      "strikePriceCurrency": "string",
      "optionExerciseStyle": "string",
      "settlementType": "string",
      "baseProduct": "string",
      "subProduct": "string",
      "furtherSubProduct": "string",
      "transactionType": "string",
      "finalPriceType": "string",
      "referenceRate": "string",
      "referenceRateType": "string",
      "irContractTerm": "string",
      "irNominalCurrency2": "string",
      "fixedRateLeg1": "string",
      "fixedRateLeg2": "string",
      "floatingRateLeg2": "string",
      "floatingRateLeg2Type": "string",
      "contractTermLeg2": "string",
      "fxNominalCurrency2": "string",
      "fxType": "string",
      "source": "string",
      "timestamp": "string"
    },
    "source": "string",
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update a Trade

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "externalId": "string",
  "transactionReferenceNumber": "string",
  "tradingVenueTransactionIdCode": "string",
  "buyerid": "string",
  "sellerid": "string",
  "tradingDateAndTime": "string",
  "tradingCapacity": "string",
  "quantity": "string",
  "quantityFormat": "string",
  "quantityCurrency": "string",
  "derivativeNotional": "string",
  "price": "string",
  "priceFormat": "string",
  "priceCurrency": "string",
  "netAmount": "string",
  "tradingVenueIdCode": "string",
  "countryOfBranchMembership": "string",
  "upFrontPayment": "string",
  "upFrontPaymentCurrency": "string",
  "securityid": "string",
  "source": "string"
}' 'https://dev.heliocor.com/blotter-api/api/static/trade/{tradeid}'
{
  "externalId": "string",
  "transactionReferenceNumber": "string",
  "tradingVenueTransactionIdCode": "string",
  "buyerid": "string",
  "sellerid": "string",
  "tradingDateAndTime": "string",
  "tradingCapacity": "string",
  "quantity": "string",
  "quantityFormat": "string",
  "quantityCurrency": "string",
  "derivativeNotional": "string",
  "price": "string",
  "priceFormat": "string",
  "priceCurrency": "string",
  "netAmount": "string",
  "tradingVenueIdCode": "string",
  "countryOfBranchMembership": "string",
  "upFrontPayment": "string",
  "upFrontPaymentCurrency": "string",
  "securityid": "string",
  "source": "string"
}

POST https://dev.heliocor.com/blotter-api/api/static/trade/{tradeid}

Updates a trade

Updates a trade.

Parameters

Name Type Required Description
externalId string false External identifier
transactionReferenceNumber string false Identification number internal to the executing firm that is unique for each transaction submitted by the firm.
tradingVenueTransactionIdCode string false Identification number generated by trading venues and disseminated to both the buying and the selling parties.
buyerid string false ISO 17442 LEI / ISO 10383 MIC / National Id / 'INTC' of the buyer
sellerid string false ISO 17442 LEI / ISO 10383 MIC / National Id / 'INTC' of the seller
tradingDateAndTime string false ISO 8601 date and time format
tradingCapacity string false 'OWN_ACCCOUNT', 'MATCHED_PRINCIPAL', 'ANY_OTHER'
quantity string false The number of units of the financial instrument, number of derivative contracts in the transaction, or the nominal or monetary value of the financial instrument.
quantityFormat string false none
quantityCurrency string false ISO 4217 Currency Code of the quantity if it is a monetary value
derivativeNotional string false 'INCREASE', 'DECREASE'
price string false 'PNDG' (Price pending), 'NOAP' (No price for transaction) or Decimal value
priceFormat string false none
priceCurrency string false ISO 4217 Currency Code of the price if it is a monetary value
netAmount string false The cash amount paid by the buyer of a debt instrument upon the settlement of the transaction.
tradingVenueIdCode string false ISO 10383 MIC of the venue where the trade is executed
countryOfBranchMembership string false ISO 3166 Country Code of the branch of the investment firm used to execute the transaction
upFrontPayment string false Monetary value of any up-front payment received or paid by the seller.
upFrontPaymentCurrency string false ISO 4217 Currency Code of the upFrontPayment
securityid string false none
source string false none

Example Response (JSON)

{}
{}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete a Trade

Example Request

# You can also use wget
curl -X DELETE -
-header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/blotter-api/api/static/trade/{tradeid}'

DELETE https://dev.heliocor.com/blotter-api/api/static/trade/{tradeid}

Deletes a trade

Deletes a trade.

Parameters

Parameter Type Required Description
tradeid string true Trade id

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

mifid

Get all RTS22

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/mifid-api/api/mifid/rts22?first=0&max=50'

GET https://dev.heliocor.com/mifid-api/api/mifid/rts22

Returns the list of RTS22 reports

Returns the list of RTS22 reports.

Parameters

Parameter Type Required Description
first integer(int32) false First report [0, -]
max integer(int32) false Max reports [1-100]

Example Response (JSON)

{
  "count": 0,
  "rts22s": [
    {
      "identifier": "string",
      "reportStatus": "string",
      "transactionReferenceNumber": "string",
      "tradingVenueTransactionIdCode": "string",
      "executingEntityIdCode": "string",
      "submittingEntityIdCode": "string",
      "investmentFirmIndicator": true,
      "buyerIdCode": "string",
      "buyerCountryOfBranch": "string",
      "buyerFirstName": "string",
      "buyerSurname": "string",
      "buyerDateOfBirth": "string",
      "sellerIdCode": "string",
      "sellerCountryOfBranch": "string",
      "sellerFirstName": "string",
      "sellerSurname": "string",
      "sellerDateOfBirth": "string",
      "buyerDMIdCode": "string",
      "buyerDMFirstName": "string",
      "buyerDMSurname": "string",
      "buyerDMDateOfBirth": "string",
      "sellerDMIdCode": "string",
      "sellerDMFirstName": "string",
      "sellerDMSurname": "string",
      "sellerDMDateOfBirth": "string",
      "transmissionOfOrderIndicator": true,
      "buyerTransmittingFirmIdCode": "string",
      "sellerTransmittingFirmIdCode": "string",
      "tradingDateAndTime": "string",
      "tradingCapacity": "string",
      "quantity": "string",
      "quantityCurrency": "string",
      "derivativeNotional": "string",
      "price": "string",
      "priceCurrency": "string",
      "netAmount": "string",
      "tradingVenueIdCode": "string",
      "countryOfBranchMembership": "string",
      "upFrontPayment": "string",
      "upFrontPaymentCurrency": "string",
      "complexTradeComponentId": "string",
      "instrumentIdCode": "string",
      "instrumentFullName": "string",
      "instrumentClassification": "string",
      "notionalCurrency1": "string",
      "notionalCurrency2": "string",
      "priceMultiplier": "string",
      "underlyingInstrument": "string",
      "underlyingIndex": "string",
      "underlyingIndexTerm": "string",
      "optionType": "string",
      "strikePrice": "string",
      "strikePriceCurrency": "string",
      "optionExerciseStyle": "string",
      "maturityDate": "string",
      "expiryDate": "string",
      "settlementType": "string",
      "investmentDecisionWithinFirm": "string",
      "countryOfBranchForDecision": "string",
      "executionWithinFirm": "string",
      "countryOfBranchForExecution": "string",
      "waiverIndicator": [
        "string"
      ],
      "shortSellingIndicator": "string",
      "otcPostTradeIndicator": [
        "string"
      ],
      "commodityDerivativeIndicator": true,
      "securitiesFinancingTransactionIndicator": true,
      "timestamp": "string"
    }
  ]
}
{
  "count": 0,
  "rts22s": [
    {
      "identifier": "string",
      "reportStatus": "string",
      "transactionReferenceNumber": "string",
      "tradingVenueTransactionIdCode": "string",
      "executingEntityIdCode": "string",
      "submittingEntityIdCode": "string",
      "investmentFirmIndicator": true,
      "buyerIdCode": "string",
      "buyerCountryOfBranch": "string",
      "buyerFirstName": "string",
      "buyerSurname": "string",
      "buyerDateOfBirth": "string",
      "sellerIdCode": "string",
      "sellerCountryOfBranch": "string",
      "sellerFirstName": "string",
      "sellerSurname": "string",
      "sellerDateOfBirth": "string",
      "buyerDMIdCode": "string",
      "buyerDMFirstName": "string",
      "buyerDMSurname": "string",
      "buyerDMDateOfBirth": "string",
      "sellerDMIdCode": "string",
      "sellerDMFirstName": "string",
      "sellerDMSurname": "string",
      "sellerDMDateOfBirth": "string",
      "transmissionOfOrderIndicator": true,
      "buyerTransmittingFirmIdCode": "string",
      "sellerTransmittingFirmIdCode": "string",
      "tradingDateAndTime": "string",
      "tradingCapacity": "string",
      "quantity": "string",
      "quantityCurrency": "string",
      "derivativeNotional": "string",
      "price": "string",
      "priceCurrency": "string",
      "netAmount": "string",
      "tradingVenueIdCode": "string",
      "countryOfBranchMembership": "string",
      "upFrontPayment": "string",
      "upFrontPaymentCurrency": "string",
      "complexTradeComponentId": "string",
      "instrumentIdCode": "string",
      "instrumentFullName": "string",
      "instrumentClassification": "string",
      "notionalCurrency1": "string",
      "notionalCurrency2": "string",
      "priceMultiplier": "string",
      "underlyingInstrument": "string",
      "underlyingIndex": "string",
      "underlyingIndexTerm": "string",
      "optionType": "string",
      "strikePrice": "string",
      "strikePriceCurrency": "string",
      "optionExerciseStyle": "string",
      "maturityDate": "string",
      "expiryDate": "string",
      "settlementType": "string",
      "investmentDecisionWithinFirm": "string",
      "countryOfBranchForDecision": "string",
      "executionWithinFirm": "string",
      "countryOfBranchForExecution": "string",
      "waiverIndicator": [
        "string"
      ],
      "shortSellingIndicator": "string",
      "otcPostTradeIndicator": [
        "string"
      ],
      "commodityDerivativeIndicator": true,
      "securitiesFinancingTransactionIndicator": true,
      "timestamp": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Add a RTS22

Example Request

# You can also use wget
curl -X POST 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "reportStatus": "string",
  "transactionReferenceNumber": "string",
  "tradingVenueTransactionIdCode": "string",
  "executingEntityIdCode": "string",
  "submittingEntityIdCode": "string",
  "investmentFirmIndicator": true,
  "buyerIdCode": "string",
  "buyerCountryOfBranch": "string",
  "buyerFirstName": "string",
  "buyerSurname": "string",
  "buyerDateOfBirth": "2018-10-09T17:26:57.755Z",
  "sellerIdCode": "string",
  "sellerCountryOfBranch": "string",
  "sellerFirstName": "string",
  "sellerSurname": "string",
  "sellerDateOfBirth": "2018-10-09T17:26:57.755Z",
  "buyerDMIdCode": "string",
  "buyerDMFirstName": "string",
  "buyerDMSurname": "string",
  "buyerDMDateOfBirth": "2018-10-09T17:26:57.755Z",
  "sellerDMIdCode": "string",
  "sellerDMFirstName": "string",
  "sellerDMSurname": "string",
  "sellerDMDateOfBirth": "2018-10-09T17:26:57.755Z",
  "transmissionOfOrderIndicator": true,
  "buyerTransmittingFirmIdCode": "string",
  "sellerTransmittingFirmIdCode": "string",
  "tradingDateAndTime": "2018-10-09T17:26:57.755Z",
  "tradingCapacity": "string",
  "quantity": "string",
  "quantityCurrency": "string",
  "derivativeNotional": "string",
  "price": "string",
  "priceCurrency": "string",
  "netAmount": "string",
  "tradingVenueIdCode": "string",
  "countryOfBranchMembership": "string",
  "upFrontPayment": "string",
  "upFrontPaymentCurrency": "string",
  "complexTradeComponentId": "string",
  "instrumentIdCode": "string",
  "instrumentFullName": "string",
  "instrumentClassification": "string",
  "notionalCurrency1": "string",
  "notionalCurrency2": "string",
  "priceMultiplier": "string",
  "underlyingInstrument": "string",
  "underlyingIndex": "string",
  "underlyingIndexTerm": "string",
  "optionType": "string",
  "strikePrice": "string",
  "strikePriceCurrency": "string",
  "optionExerciseStyle": "string",
  "maturityDate": "2018-10-09T17:26:57.755Z",
  "expiryDate": "2018-10-09T17:26:57.755Z",
  "settlementType": "string",
  "investmentDecisionWithinFirm": "string",
  "countryOfBranchForDecision": "string",
  "executionWithinFirm": "string",
  "countryOfBranchForExecution": "string",
  "waiverIndicator": [
    "string"
  ],
  "shortSellingIndicator": "string",
  "otcPostTradeIndicator": [
    "string"
  ],
  "commodityDerivativeIndicator": true,
  "securitiesFinancingTransactionIndicator": true
}' 'https://dev.heliocor.com/mifid-api/api/mifid/rts22'
{
  "reportStatus": "string",
  "transactionReferenceNumber": "string",
  "tradingVenueTransactionIdCode": "string",
  "executingEntityIdCode": "string",
  "submittingEntityIdCode": "string",
  "investmentFirmIndicator": true,
  "buyerIdCode": "string",
  "buyerCountryOfBranch": "string",
  "buyerFirstName": "string",
  "buyerSurname": "string",
  "buyerDateOfBirth": "2018-10-09T17:26:57.755Z",
  "sellerIdCode": "string",
  "sellerCountryOfBranch": "string",
  "sellerFirstName": "string",
  "sellerSurname": "string",
  "sellerDateOfBirth": "2018-10-09T17:26:57.755Z",
  "buyerDMIdCode": "string",
  "buyerDMFirstName": "string",
  "buyerDMSurname": "string",
  "buyerDMDateOfBirth": "2018-10-09T17:26:57.755Z",
  "sellerDMIdCode": "string",
  "sellerDMFirstName": "string",
  "sellerDMSurname": "string",
  "sellerDMDateOfBirth": "2018-10-09T17:26:57.755Z",
  "transmissionOfOrderIndicator": true,
  "buyerTransmittingFirmIdCode": "string",
  "sellerTransmittingFirmIdCode": "string",
  "tradingDateAndTime": "2018-10-09T17:26:57.755Z",
  "tradingCapacity": "string",
  "quantity": "string",
  "quantityCurrency": "string",
  "derivativeNotional": "string",
  "price": "string",
  "priceCurrency": "string",
  "netAmount": "string",
  "tradingVenueIdCode": "string",
  "countryOfBranchMembership": "string",
  "upFrontPayment": "string",
  "upFrontPaymentCurrency": "string",
  "complexTradeComponentId": "string",
  "instrumentIdCode": "string",
  "instrumentFullName": "string",
  "instrumentClassification": "string",
  "notionalCurrency1": "string",
  "notionalCurrency2": "string",
  "priceMultiplier": "string",
  "underlyingInstrument": "string",
  "underlyingIndex": "string",
  "underlyingIndexTerm": "string",
  "optionType": "string",
  "strikePrice": "string",
  "strikePriceCurrency": "string",
  "optionExerciseStyle": "string",
  "maturityDate": "2018-10-09T17:26:57.755Z",
  "expiryDate": "2018-10-09T17:26:57.755Z",
  "settlementType": "string",
  "investmentDecisionWithinFirm": "string",
  "countryOfBranchForDecision": "string",
  "executionWithinFirm": "string",
  "countryOfBranchForExecution": "string",
  "waiverIndicator": [
    "string"
  ],
  "shortSellingIndicator": "string",
  "otcPostTradeIndicator": [
    "string"
  ],
  "commodityDerivativeIndicator": true,
  "securitiesFinancingTransactionIndicator": true
}

POST https://dev.heliocor.com/mifid-api/api/mifid/rts22

Adds a RTS22 report

Adds a RTS22 report.

Parameters

Name Type Required Description
reportStatus string false 'NEW', 'CANCELLATION'
transactionReferenceNumber string false Identification number internal to the executing firm that is unique for each transaction submitted by the firm.
tradingVenueTransactionIdCode string false Identification number generated by trading venues and disseminated to both the buying and the selling parties.
executingEntityIdCode string false ISO 17442 LEI
submittingEntityIdCode string false ISO 17442 LEI
investmentFirmIndicator boolean false True, False
buyerIdCode string false ISO 17442 LEI / ISO 10383 MIC / National Id / 'INTC' of the buyer
buyerCountryOfBranch string false ISO 3166 Country Code of the buyer
buyerFirstName string false Buyer First Name
buyerSurname string false Buyer Surname
buyerDateOfBirth string(date-time) false Date of birth of the buyer. ISO 8601 date format
sellerIdCode string false ISO 17442 LEI / ISO 10383 MIC / National Id / 'INTC' of the seller
sellerCountryOfBranch string false ISO 3166 Country Code of the seller
sellerFirstName string false Seller First Name
sellerSurname string false Seller Surname
sellerDateOfBirth string(date-time) false Date of birth of the seller. ISO 8601 date format
buyerDMIdCode string false ISO 17442 LEI / National Id of the buyer decision maker
buyerDMFirstName string false Buyer Decision Maker First Name
buyerDMSurname string false Buyer Decision Maker Surname
buyerDMDateOfBirth string(date-time) false Date of birth of the buyer decision maker. ISO 8601 date format
sellerDMIdCode string false ISO 17442 LEI / National Id of the seller decision maker
sellerDMFirstName string false Seller Decision Maker First Name
sellerDMSurname string false Seller Decision Maker Surname
sellerDMDateOfBirth string(date-time) false Date of birth of the seller decision maker. ISO 8601 date format
transmissionOfOrderIndicator boolean false True, False
buyerTransmittingFirmIdCode string false ISO 17442 LEI
sellerTransmittingFirmIdCode string false ISO 17442 LEI
tradingDateAndTime string(date-time) false ISO 8601 date and time format
tradingCapacity string false 'OWN_ACCCOUNT', 'MATCHED_PRINCIPAL', 'ANY_OTHER'
quantity string false The number of units of the financial instrument, number of derivative contracts in the transaction, or the nominal or monetary value of the financial instrument.
quantityCurrency string false ISO 4217 Currency Code of the quantity if it is a monetary value
derivativeNotional string false 'INCREASE', 'DECREASE'
price string false 'PNDG' (Price pending), 'NOAP' (No price for transaction) or Decimal value
priceCurrency string false ISO 4217 Currency Code of the price if it is a monetary value
netAmount string false The cash amount paid by the buyer of a debt instrument upon the settlement of the transaction.
tradingVenueIdCode string false ISO 10383 MIC of the venue where the trade is executed
countryOfBranchMembership string false ISO 3166 Country Code of the branch of the investment firm used to execute the transaction
upFrontPayment string false Monetary value of any up-front payment received or paid by the seller.
upFrontPaymentCurrency string false ISO 4217 Currency Code of the upFrontPayment
complexTradeComponentId string false Identifier, internal to the reporting firm to identify all the reports related to the same execution of a combination of financial instruments.
instrumentIdCode string false ISO 6166 ISIN. Code used to identify the financial instrument.
instrumentFullName string false Full name of the financial instrument.
instrumentClassification string false ISO 10962 CFI. Taxonomy used to classify the financial instrument.
notionalCurrency1 string false ISO 4217 Currency Code. Currency in which the notional is denominated.
notionalCurrency2 string false ISO 4217 Currency Code. For multi-currency or cross-currency swaps the currency in which leg 2 of the contract is denominated.
priceMultiplier string false Number of units of the underlying instrument represented by a single derivative contract.
underlyingInstrument string false ISO 6166 ISIN. ISIN code of the underlying instrument.
underlyingIndex string false INDEX code or full name of the index.
underlyingIndexTerm string false Term of the index. INT(3) + ‘DAYS’, INT(3) + ‘WEEK’, INT(3) + ‘MNTH’, INT(3) + ‘YEAR’,
optionType string false 'PUT', 'CALL', 'UNKNOWN'
strikePrice string false 'PNDG' (Price pending) or Decimal value. Pre-determined price at which the holder will have to buy or sell the underlying instrument.
strikePriceCurrency string false ISO 4217 Currency Code if strikePrice is a Decimal Value
optionExerciseStyle string false 'EUROPEAN', 'AMERICAN', 'ASIAN', 'BERMUDAN', 'ANY_OTHER'
maturityDate string(date-time) false ISO 8601 date format. Date of maturity of the financial instrument.
expiryDate string(date-time) false ISO 8601 date format. Expiry date of the financial instrument.
settlementType string false 'PHYSICALLY', 'CASH', 'OPTIONAL'
investmentDecisionWithinFirm string false National Id / Algorithm. Code used to identify the person or algorithm within the investment firm who is responsible for the investment decision.
countryOfBranchForDecision string false ISO 3166 Country Code of the branch of the investment firm responsible for the investment decision.
executionWithinFirm string false National Id / Algorithm. Code used to identify the person or algorithm within the investment firm who is responsible for the execution.
countryOfBranchForExecution string false ISO 3166 Country Code of the branch of the investment firm responsible for the investment execution.
waiverIndicator [string] false 'REFERENCE_PRICE', 'NEGOTIATED_LIQUID', 'NEGOTIATED_ILLIQUID', 'NEGOTIATED_CONDITIONS', 'ABOVE_SPECIFIED_SIZE', 'ILLIQUID_INSTRUMENT'
shortSellingIndicator string false 'SS_WITH_NO_EXEMPTION', 'SS_WITH_EXEMPTION', 'NO_SS', 'NO_INFORMATION'
otcPostTradeIndicator [string] false 'BENCHMARK', 'AGENCY_CROSS', 'LARGE_IN_SCALE', 'ILLIQUID_INSTRUMENT', 'ABOVE_SPECIFIED_SIZE', 'CANCELLATIONS', 'AMMENDMENTS', 'SPECIAL_DIVIDEND', 'PRICE_IMPROVEMENT', 'DUPLICATIVE', 'NOT_CONTRIBUTING_TO_PRICE_DISCOVERY', 'PACKAGE', 'EXCHANGE_FOR_PHYSICAL'
commodityDerivativeIndicator boolean false Indication as to whether the transaction reduces risk in an objectively measurable way in accordance with Article 57 of Directive 2014/65/EU. True, False
securitiesFinancingTransactionIndicator boolean false Indication that a transaction falls within the scope of activity but is exempted from reporting under Securities Financing Transactions Regulation. True, False

Example Response (JSON)

{
  "rts22": {
    "identifier": "string",
    "reportStatus": "string",
    "transactionReferenceNumber": "string",
    "tradingVenueTransactionIdCode": "string",
    "executingEntityIdCode": "string",
    "submittingEntityIdCode": "string",
    "investmentFirmIndicator": true,
    "buyerIdCode": "string",
    "buyerCountryOfBranch": "string",
    "buyerFirstName": "string",
    "buyerSurname": "string",
    "buyerDateOfBirth": "string",
    "sellerIdCode": "string",
    "sellerCountryOfBranch": "string",
    "sellerFirstName": "string",
    "sellerSurname": "string",
    "sellerDateOfBirth": "string",
    "buyerDMIdCode": "string",
    "buyerDMFirstName": "string",
    "buyerDMSurname": "string",
    "buyerDMDateOfBirth": "string",
    "sellerDMIdCode": "string",
    "sellerDMFirstName": "string",
    "sellerDMSurname": "string",
    "sellerDMDateOfBirth": "string",
    "transmissionOfOrderIndicator": true,
    "buyerTransmittingFirmIdCode": "string",
    "sellerTransmittingFirmIdCode": "string",
    "tradingDateAndTime": "string",
    "tradingCapacity": "string",
    "quantity": "string",
    "quantityCurrency": "string",
    "derivativeNotional": "string",
    "price": "string",
    "priceCurrency": "string",
    "netAmount": "string",
    "tradingVenueIdCode": "string",
    "countryOfBranchMembership": "string",
    "upFrontPayment": "string",
    "upFrontPaymentCurrency": "string",
    "complexTradeComponentId": "string",
    "instrumentIdCode": "string",
    "instrumentFullName": "string",
    "instrumentClassification": "string",
    "notionalCurrency1": "string",
    "notionalCurrency2": "string",
    "priceMultiplier": "string",
    "underlyingInstrument": "string",
    "underlyingIndex": "string",
    "underlyingIndexTerm": "string",
    "optionType": "string",
    "strikePrice": "string",
    "strikePriceCurrency": "string",
    "optionExerciseStyle": "string",
    "maturityDate": "string",
    "expiryDate": "string",
    "settlementType": "string",
    "investmentDecisionWithinFirm": "string",
    "countryOfBranchForDecision": "string",
    "executionWithinFirm": "string",
    "countryOfBranchForExecution": "string",
    "waiverIndicator": [
      "string"
    ],
    "shortSellingIndicator": "string",
    "otcPostTradeIndicator": [
      "string"
    ],
    "commodityDerivativeIndicator": true,
    "securitiesFinancingTransactionIndicator": true,
    "timestamp": "string"
  }
}
{
  "rts22": {
    "identifier": "string",
    "reportStatus": "string",
    "transactionReferenceNumber": "string",
    "tradingVenueTransactionIdCode": "string",
    "executingEntityIdCode": "string",
    "submittingEntityIdCode": "string",
    "investmentFirmIndicator": true,
    "buyerIdCode": "string",
    "buyerCountryOfBranch": "string",
    "buyerFirstName": "string",
    "buyerSurname": "string",
    "buyerDateOfBirth": "string",
    "sellerIdCode": "string",
    "sellerCountryOfBranch": "string",
    "sellerFirstName": "string",
    "sellerSurname": "string",
    "sellerDateOfBirth": "string",
    "buyerDMIdCode": "string",
    "buyerDMFirstName": "string",
    "buyerDMSurname": "string",
    "buyerDMDateOfBirth": "string",
    "sellerDMIdCode": "string",
    "sellerDMFirstName": "string",
    "sellerDMSurname": "string",
    "sellerDMDateOfBirth": "string",
    "transmissionOfOrderIndicator": true,
    "buyerTransmittingFirmIdCode": "string",
    "sellerTransmittingFirmIdCode": "string",
    "tradingDateAndTime": "string",
    "tradingCapacity": "string",
    "quantity": "string",
    "quantityCurrency": "string",
    "derivativeNotional": "string",
    "price": "string",
    "priceCurrency": "string",
    "netAmount": "string",
    "tradingVenueIdCode": "string",
    "countryOfBranchMembership": "string",
    "upFrontPayment": "string",
    "upFrontPaymentCurrency": "string",
    "complexTradeComponentId": "string",
    "instrumentIdCode": "string",
    "instrumentFullName": "string",
    "instrumentClassification": "string",
    "notionalCurrency1": "string",
    "notionalCurrency2": "string",
    "priceMultiplier": "string",
    "underlyingInstrument": "string",
    "underlyingIndex": "string",
    "underlyingIndexTerm": "string",
    "optionType": "string",
    "strikePrice": "string",
    "strikePriceCurrency": "string",
    "optionExerciseStyle": "string",
    "maturityDate": "string",
    "expiryDate": "string",
    "settlementType": "string",
    "investmentDecisionWithinFirm": "string",
    "countryOfBranchForDecision": "string",
    "executionWithinFirm": "string",
    "countryOfBranchForExecution": "string",
    "waiverIndicator": [
      "string"
    ],
    "shortSellingIndicator": "string",
    "otcPostTradeIndicator": [
      "string"
    ],
    "commodityDerivativeIndicator": true,
    "securitiesFinancingTransactionIndicator": true,
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Get a RTS22

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/mifid-api/api/mifid/rts22/{rts22id}'

GET https://dev.heliocor.com/mifid-api/api/mifid/rts22/{rts22id}

Returns a RTS22 report

Returns a RTS22 report.

Parameters

Parameter Type Required Description
rts22id string true RTS22 identifier

Example Response (JSON)

{
  "rts22": {
    "identifier": "string",
    "reportStatus": "string",
    "transactionReferenceNumber": "string",
    "tradingVenueTransactionIdCode": "string",
    "executingEntityIdCode": "string",
    "submittingEntityIdCode": "string",
    "investmentFirmIndicator": true,
    "buyerIdCode": "string",
    "buyerCountryOfBranch": "string",
    "buyerFirstName": "string",
    "buyerSurname": "string",
    "buyerDateOfBirth": "string",
    "sellerIdCode": "string",
    "sellerCountryOfBranch": "string",
    "sellerFirstName": "string",
    "sellerSurname": "string",
    "sellerDateOfBirth": "string",
    "buyerDMIdCode": "string",
    "buyerDMFirstName": "string",
    "buyerDMSurname": "string",
    "buyerDMDateOfBirth": "string",
    "sellerDMIdCode": "string",
    "sellerDMFirstName": "string",
    "sellerDMSurname": "string",
    "sellerDMDateOfBirth": "string",
    "transmissionOfOrderIndicator": true,
    "buyerTransmittingFirmIdCode": "string",
    "sellerTransmittingFirmIdCode": "string",
    "tradingDateAndTime": "string",
    "tradingCapacity": "string",
    "quantity": "string",
    "quantityCurrency": "string",
    "derivativeNotional": "string",
    "price": "string",
    "priceCurrency": "string",
    "netAmount": "string",
    "tradingVenueIdCode": "string",
    "countryOfBranchMembership": "string",
    "upFrontPayment": "string",
    "upFrontPaymentCurrency": "string",
    "complexTradeComponentId": "string",
    "instrumentIdCode": "string",
    "instrumentFullName": "string",
    "instrumentClassification": "string",
    "notionalCurrency1": "string",
    "notionalCurrency2": "string",
    "priceMultiplier": "string",
    "underlyingInstrument": "string",
    "underlyingIndex": "string",
    "underlyingIndexTerm": "string",
    "optionType": "string",
    "strikePrice": "string",
    "strikePriceCurrency": "string",
    "optionExerciseStyle": "string",
    "maturityDate": "string",
    "expiryDate": "string",
    "settlementType": "string",
    "investmentDecisionWithinFirm": "string",
    "countryOfBranchForDecision": "string",
    "executionWithinFirm": "string",
    "countryOfBranchForExecution": "string",
    "waiverIndicator": [
      "string"
    ],
    "shortSellingIndicator": "string",
    "otcPostTradeIndicator": [
      "string"
    ],
    "commodityDerivativeIndicator": true,
    "securitiesFinancingTransactionIndicator": true,
    "timestamp": "string"
  }
}
{
  "rts22": {
    "identifier": "string",
    "reportStatus": "string",
    "transactionReferenceNumber": "string",
    "tradingVenueTransactionIdCode": "string",
    "executingEntityIdCode": "string",
    "submittingEntityIdCode": "string",
    "investmentFirmIndicator": true,
    "buyerIdCode": "string",
    "buyerCountryOfBranch": "string",
    "buyerFirstName": "string",
    "buyerSurname": "string",
    "buyerDateOfBirth": "string",
    "sellerIdCode": "string",
    "sellerCountryOfBranch": "string",
    "sellerFirstName": "string",
    "sellerSurname": "string",
    "sellerDateOfBirth": "string",
    "buyerDMIdCode": "string",
    "buyerDMFirstName": "string",
    "buyerDMSurname": "string",
    "buyerDMDateOfBirth": "string",
    "sellerDMIdCode": "string",
    "sellerDMFirstName": "string",
    "sellerDMSurname": "string",
    "sellerDMDateOfBirth": "string",
    "transmissionOfOrderIndicator": true,
    "buyerTransmittingFirmIdCode": "string",
    "sellerTransmittingFirmIdCode": "string",
    "tradingDateAndTime": "string",
    "tradingCapacity": "string",
    "quantity": "string",
    "quantityCurrency": "string",
    "derivativeNotional": "string",
    "price": "string",
    "priceCurrency": "string",
    "netAmount": "string",
    "tradingVenueIdCode": "string",
    "countryOfBranchMembership": "string",
    "upFrontPayment": "string",
    "upFrontPaymentCurrency": "string",
    "complexTradeComponentId": "string",
    "instrumentIdCode": "string",
    "instrumentFullName": "string",
    "instrumentClassification": "string",
    "notionalCurrency1": "string",
    "notionalCurrency2": "string",
    "priceMultiplier": "string",
    "underlyingInstrument": "string",
    "underlyingIndex": "string",
    "underlyingIndexTerm": "string",
    "optionType": "string",
    "strikePrice": "string",
    "strikePriceCurrency": "string",
    "optionExerciseStyle": "string",
    "maturityDate": "string",
    "expiryDate": "string",
    "settlementType": "string",
    "investmentDecisionWithinFirm": "string",
    "countryOfBranchForDecision": "string",
    "executionWithinFirm": "string",
    "countryOfBranchForExecution": "string",
    "waiverIndicator": [
      "string"
    ],
    "shortSellingIndicator": "string",
    "otcPostTradeIndicator": [
      "string"
    ],
    "commodityDerivativeIndicator": true,
    "securitiesFinancingTransactionIndicator": true,
    "timestamp": "string"
  }
}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Update RTS22

Example Request

# You can also use wget
curl -X PUT 
--header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' -d '{
  "reportStatus": "string",
  "transactionReferenceNumber": "string",
  "tradingVenueTransactionIdCode": "string",
  "executingEntityIdCode": "string",
  "submittingEntityIdCode": "string",
  "investmentFirmIndicator": true,
  "buyerIdCode": "string",
  "buyerCountryOfBranch": "string",
  "buyerFirstName": "string",
  "buyerSurname": "string",
  "buyerDateOfBirth": "2018-10-09T17:26:57.769Z",
  "sellerIdCode": "string",
  "sellerCountryOfBranch": "string",
  "sellerFirstName": "string",
  "sellerSurname": "string",
  "sellerDateOfBirth": "2018-10-09T17:26:57.769Z",
  "buyerDMIdCode": "string",
  "buyerDMFirstName": "string",
  "buyerDMSurname": "string",
  "buyerDMDateOfBirth": "2018-10-09T17:26:57.769Z",
  "sellerDMIdCode": "string",
  "sellerDMFirstName": "string",
  "sellerDMSurname": "string",
  "sellerDMDateOfBirth": "2018-10-09T17:26:57.769Z",
  "transmissionOfOrderIndicator": true,
  "buyerTransmittingFirmIdCode": "string",
  "sellerTransmittingFirmIdCode": "string",
  "tradingDateAndTime": "2018-10-09T17:26:57.769Z",
  "tradingCapacity": "string",
  "quantity": "string",
  "quantityCurrency": "string",
  "derivativeNotional": "string",
  "price": "string",
  "priceCurrency": "string",
  "netAmount": "string",
  "tradingVenueIdCode": "string",
  "countryOfBranchMembership": "string",
  "upFrontPayment": "string",
  "upFrontPaymentCurrency": "string",
  "complexTradeComponentId": "string",
  "instrumentIdCode": "string",
  "instrumentFullName": "string",
  "instrumentClassification": "string",
  "notionalCurrency1": "string",
  "notionalCurrency2": "string",
  "priceMultiplier": "string",
  "underlyingInstrument": "string",
  "underlyingIndex": "string",
  "underlyingIndexTerm": "string",
  "optionType": "string",
  "strikePrice": "string",
  "strikePriceCurrency": "string",
  "optionExerciseStyle": "string",
  "maturityDate": "2018-10-09T17:26:57.769Z",
  "expiryDate": "2018-10-09T17:26:57.769Z",
  "settlementType": "string",
  "investmentDecisionWithinFirm": "string",
  "countryOfBranchForDecision": "string",
  "executionWithinFirm": "string",
  "countryOfBranchForExecution": "string",
  "waiverIndicator": [
    "string"
  ],
  "shortSellingIndicator": "string",
  "otcPostTradeIndicator": [
    "string"
  ],
  "commodityDerivativeIndicator": true,
  "securitiesFinancingTransactionIndicator": true
}' 'https://dev.heliocor.com/mifid-api/api/mifid/rts22/{rts22id}'
{
  "reportStatus": "string",
  "transactionReferenceNumber": "string",
  "tradingVenueTransactionIdCode": "string",
  "executingEntityIdCode": "string",
  "submittingEntityIdCode": "string",
  "investmentFirmIndicator": true,
  "buyerIdCode": "string",
  "buyerCountryOfBranch": "string",
  "buyerFirstName": "string",
  "buyerSurname": "string",
  "buyerDateOfBirth": "2018-10-09T17:23:46Z",
  "sellerIdCode": "string",
  "sellerCountryOfBranch": "string",
  "sellerFirstName": "string",
  "sellerSurname": "string",
  "sellerDateOfBirth": "2018-10-09T17:23:46Z",
  "buyerDMIdCode": "string",
  "buyerDMFirstName": "string",
  "buyerDMSurname": "string",
  "buyerDMDateOfBirth": "2018-10-09T17:23:46Z",
  "sellerDMIdCode": "string",
  "sellerDMFirstName": "string",
  "sellerDMSurname": "string",
  "sellerDMDateOfBirth": "2018-10-09T17:23:46Z",
  "transmissionOfOrderIndicator": true,
  "buyerTransmittingFirmIdCode": "string",
  "sellerTransmittingFirmIdCode": "string",
  "tradingDateAndTime": "2018-10-09T17:23:46Z",
  "tradingCapacity": "string",
  "quantity": "string",
  "quantityCurrency": "string",
  "derivativeNotional": "string",
  "price": "string",
  "priceCurrency": "string",
  "netAmount": "string",
  "tradingVenueIdCode": "string",
  "countryOfBranchMembership": "string",
  "upFrontPayment": "string",
  "upFrontPaymentCurrency": "string",
  "complexTradeComponentId": "string",
  "instrumentIdCode": "string",
  "instrumentFullName": "string",
  "instrumentClassification": "string",
  "notionalCurrency1": "string",
  "notionalCurrency2": "string",
  "priceMultiplier": "string",
  "underlyingInstrument": "string",
  "underlyingIndex": "string",
  "underlyingIndexTerm": "string",
  "optionType": "string",
  "strikePrice": "string",
  "strikePriceCurrency": "string",
  "optionExerciseStyle": "string",
  "maturityDate": "2018-10-09T17:23:46Z",
  "expiryDate": "2018-10-09T17:23:46Z",
  "settlementType": "string",
  "investmentDecisionWithinFirm": "string",
  "countryOfBranchForDecision": "string",
  "executionWithinFirm": "string",
  "countryOfBranchForExecution": "string",
  "waiverIndicator": [
    "string"
  ],
  "shortSellingIndicator": "string",
  "otcPostTradeIndicator": [
    "string"
  ],
  "commodityDerivativeIndicator": true,
  "securitiesFinancingTransactionIndicator": true
}

PUT https://dev.heliocor.com/mifid-api/api/mifid/rts22/{rts22id}

Updates a RTS22 report

Updates a RTS22 report.

URL Parameters

Name Type Required Description
reportStatus string false 'NEW', 'CANCELLATION'
transactionReferenceNumber string false Identification number internal to the executing firm that is unique for each transaction submitted by the firm.
tradingVenueTransactionIdCode string false Identification number generated by trading venues and disseminated to both the buying and the selling parties.
executingEntityIdCode string false ISO 17442 LEI
submittingEntityIdCode string false ISO 17442 LEI
investmentFirmIndicator boolean false True, False
buyerIdCode string false ISO 17442 LEI / ISO 10383 MIC / National Id / 'INTC' of the buyer
buyerCountryOfBranch string false ISO 3166 Country Code of the buyer
buyerFirstName string false Buyer First Name
buyerSurname string false Buyer Surname
buyerDateOfBirth string(date-time) false Date of birth of the buyer. ISO 8601 date format
sellerIdCode string false ISO 17442 LEI / ISO 10383 MIC / National Id / 'INTC' of the seller
sellerCountryOfBranch string false ISO 3166 Country Code of the seller
sellerFirstName string false Seller First Name
sellerSurname string false Seller Surname
sellerDateOfBirth string(date-time) false Date of birth of the seller. ISO 8601 date format
buyerDMIdCode string false ISO 17442 LEI / National Id of the buyer decision maker
buyerDMFirstName string false Buyer Decision Maker First Name
buyerDMSurname string false Buyer Decision Maker Surname
buyerDMDateOfBirth string(date-time) false Date of birth of the buyer decision maker. ISO 8601 date format
sellerDMIdCode string false ISO 17442 LEI / National Id of the seller decision maker
sellerDMFirstName string false Seller Decision Maker First Name
sellerDMSurname string false Seller Decision Maker Surname
sellerDMDateOfBirth string(date-time) false Date of birth of the seller decision maker. ISO 8601 date format
transmissionOfOrderIndicator boolean false True, False
buyerTransmittingFirmIdCode string false ISO 17442 LEI
sellerTransmittingFirmIdCode string false ISO 17442 LEI
tradingDateAndTime string(date-time) false ISO 8601 date and time format
tradingCapacity string false 'OWN_ACCCOUNT', 'MATCHED_PRINCIPAL', 'ANY_OTHER'
quantity string false The number of units of the financial instrument, number of derivative contracts in the transaction, or the nominal or monetary value of the financial instrument.
quantityCurrency string false ISO 4217 Currency Code of the quantity if it is a monetary value
derivativeNotional string false 'INCREASE', 'DECREASE'
price string false 'PNDG' (Price pending), 'NOAP' (No price for transaction) or Decimal value
priceCurrency string false ISO 4217 Currency Code of the price if it is a monetary value
netAmount string false The cash amount paid by the buyer of a debt instrument upon the settlement of the transaction.
tradingVenueIdCode string false ISO 10383 MIC of the venue where the trade is executed
countryOfBranchMembership string false ISO 3166 Country Code of the branch of the investment firm used to execute the transaction
upFrontPayment string false Monetary value of any up-front payment received or paid by the seller.
upFrontPaymentCurrency string false ISO 4217 Currency Code of the upFrontPayment
complexTradeComponentId string false Identifier, internal to the reporting firm to identify all the reports related to the same execution of a combination of financial instruments.
instrumentIdCode string false ISO 6166 ISIN. Code used to identify the financial instrument.
instrumentFullName string false Full name of the financial instrument.
instrumentClassification string false ISO 10962 CFI. Taxonomy used to classify the financial instrument.
notionalCurrency1 string false ISO 4217 Currency Code. Currency in which the notional is denominated.
notionalCurrency2 string false ISO 4217 Currency Code. For multi-currency or cross-currency swaps the currency in which leg 2 of the contract is denominated.
priceMultiplier string false Number of units of the underlying instrument represented by a single derivative contract.
underlyingInstrument string false ISO 6166 ISIN. ISIN code of the underlying instrument.
underlyingIndex string false INDEX code or full name of the index.
underlyingIndexTerm string false Term of the index. INT(3) + ‘DAYS’, INT(3) + ‘WEEK’, INT(3) + ‘MNTH’, INT(3) + ‘YEAR’,
optionType string false 'PUT', 'CALL', 'UNKNOWN'
strikePrice string false 'PNDG' (Price pending) or Decimal value. Pre-determined price at which the holder will have to buy or sell the underlying instrument.
strikePriceCurrency string false ISO 4217 Currency Code if strikePrice is a Decimal Value
optionExerciseStyle string false 'EUROPEAN', 'AMERICAN', 'ASIAN', 'BERMUDAN', 'ANY_OTHER'
maturityDate string(date-time) false ISO 8601 date format. Date of maturity of the financial instrument.
expiryDate string(date-time) false ISO 8601 date format. Expiry date of the financial instrument.
settlementType string false 'PHYSICALLY', 'CASH', 'OPTIONAL'
investmentDecisionWithinFirm string false National Id / Algorithm. Code used to identify the person or algorithm within the investment firm who is responsible for the investment decision.
countryOfBranchForDecision string false ISO 3166 Country Code of the branch of the investment firm responsible for the investment decision.
executionWithinFirm string false National Id / Algorithm. Code used to identify the person or algorithm within the investment firm who is responsible for the execution.
countryOfBranchForExecution string false ISO 3166 Country Code of the branch of the investment firm responsible for the investment execution.
waiverIndicator [string] false 'REFERENCE_PRICE', 'NEGOTIATED_LIQUID', 'NEGOTIATED_ILLIQUID', 'NEGOTIATED_CONDITIONS', 'ABOVE_SPECIFIED_SIZE', 'ILLIQUID_INSTRUMENT'
shortSellingIndicator string false 'SS_WITH_NO_EXEMPTION', 'SS_WITH_EXEMPTION', 'NO_SS', 'NO_INFORMATION'
otcPostTradeIndicator [string] false 'BENCHMARK', 'AGENCY_CROSS', 'LARGE_IN_SCALE', 'ILLIQUID_INSTRUMENT', 'ABOVE_SPECIFIED_SIZE', 'CANCELLATIONS', 'AMMENDMENTS', 'SPECIAL_DIVIDEND', 'PRICE_IMPROVEMENT', 'DUPLICATIVE', 'NOT_CONTRIBUTING_TO_PRICE_DISCOVERY', 'PACKAGE', 'EXCHANGE_FOR_PHYSICAL'
commodityDerivativeIndicator boolean false Indication as to whether the transaction reduces risk in an objectively measurable way in accordance with Article 57 of Directive 2014/65/EU. True, False
securitiesFinancingTransactionIndicator boolean false Indication that a transaction falls within the scope of activity but is exempted from reporting under Securities Financing Transactions Regulation. True, False

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Delete RTS22

Example Request

# You can also use wget
curl -X DELETE 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/mifid-api/api/mifid/rts22/{rts22id}'

DELETE https://dev.heliocor.com/mifid-api/api/mifid/rts22/{rts22id}

Deletes a RTS22 report

Deletes a RTS22 report.

Parameters

Parameter Type Required Description
rts22id string true RTS22 identifier

Example Response (JSON)

{}
{}

Responses

Status Meaning Description
200 OK Successful Operation
400 Bad Request Bad request
401 Unauthorized Unauthorized

Static API

Static

Get Document Types

Example Request

# You can also use wget
curl -X GET 
--header 'Accept: application/json' 
--header 'Authorization: Bearer TOKEN' 
'https://dev.heliocor.com/dokstor-bo-api/api/static/type'

GET https://dev.heliocor.com/dokstor-bo-api/api/static/type

Returns the list of available document types

Returns the list of available document types. Access: kyc.

Example Response (JSON)

{
            "types": [
              "PASSPORT",
              "IDENTITY_CARD_FRONT",
              "IDENTITY_CARD_BACK",
              "DRIVING_LICENSE",
              "SELFIE",
              "BIRTH_CERTIFICATE",
              "BANK_STATEMENT_PERSONAL",
              "MARRIAGE_CERTIFICATE",
              "DIVORCE_DOCUMENTS",
              "PAYSLIP",
              "PERSONAL_ADDRESS",
              "PREVIOUS_ADDRESSES",
              "PROOF_OF_AGE",
              "RIGHT_TO_REMAIN_RESIDENCE",
              "VISA_RESIDENCE",
              "ELECTRICITY_BILL",
              "WATER_BILL",
              "GAS_BILL",
              "TELEPHONE_BILL",
              "COUNCIL_TAX_BILL",
              "COMPANY_DATA",
              "PROFIT_AND_LOSS",
              "BALANCE_SHEET",
              "BANK_STATEMENT_COMPANY",
              "OTHER_PARTIES",
              "HOME_INSURANCE_CERTIFICATE",
              "CAR_INSURANCE_CERTIFICATE",
              "LIFE_INSURANCE_CERTIFICATE",
              "HEALTH_INSURANCE_CERTIFICATE",
              "DEGREE_CERTIFICATES",
              "SCHOOL_EXAM_CERTIFICATES",
              "STUDENT_UNION_CATEGORY",
              "MEMBERSHIP_CATEGORIES"
            ]
          }
          
{
            "types": [
              "PASSPORT",
              "IDENTITY_CARD_FRONT",
              "IDENTITY_CARD_BACK",
              "DRIVING_LICENSE",
              "SELFIE",
              "BIRTH_CERTIFICATE",
              "BANK_STATEMENT_PERSONAL",
              "MARRIAGE_CERTIFICATE",
              "DIVORCE_DOCUMENTS",
              "PAYSLIP",
              "PERSONAL_ADDRESS",
              "PREVIOUS_ADDRESSES",
              "PROOF_OF_AGE",
              "RIGHT_TO_REMAIN_RESIDENCE",
              "VISA_RESIDENCE",
              "ELECTRICITY_BILL",
              "WATER_BILL",
              "GAS_BILL",
              "TELEPHONE_BILL",
              "COUNCIL_TAX_BILL",
              "COMPANY_DATA",
              "PROFIT_AND_LOSS",
              "BALANCE_SHEET",
              "BANK_STATEMENT_COMPANY",
              "OTHER_PARTIES",
              "HOME_INSURANCE_CERTIFICATE",
              "CAR_INSURANCE_CERTIFICATE",
              "LIFE_INSURANCE_CERTIFICATE",
              "HEALTH_INSURANCE_CERTIFICATE",
              "DEGREE_CERTIFICATES",
              "SCHOOL_EXAM_CERTIFICATES",
              "STUDENT_UNION_CATEGORY",
              "MEMBERSHIP_CATEGORIES"
            ]
          }
          

Responses

Status Meaning Description
200 OK successful operation
400 Bad Request Bad request
401 Unauthorized Unauthorized