Introduction

This reference provides detailed documentation for the RocketKOR REST APIs. Our APIs use standard HTTP request methods (such as GET, PUT, POST, and DELETE) and standard HTTP response codes for errors along with detailed error messaging. Requests and responses follow the standard JSON format.

Authentication

RocketKOR authenticates API requests using HTTP Basic Authentication. When calling a RocketKOR API, you must include an Authorization header (Basic Auth) where the username is your API key ID and the password is your API key secret.

Sorting and Pagination

Sorting and pagination are supported for most RocketKOR APIs that return arrays of resources. You can control sorting and pagination through URL query parameters.

Sorting Query Parameters

Use the sort parameter to specify a sort field and an optional sort order (ASC or DESC). For example, the following parameters would sort the results by two fields: first the createdAt field in descending order, then the title field in ascending order.

GET {endpoint}?sort=createdAt,DESC&sort=title,ASC

Pagination Query Parameters

Use the page (page number to return) and size (maximum number of results to return per page) parameters to limit the number of results and keep responses to a reasonable size. For example, to return the first 10 records on the first page, use page=0 and size=10.

The response includes paging information followed by the content array. The following fields are returned:

totalElements  Total number of available elements.
totalPages  Total number of available pages.
number  Page number returned.
numberOfElements  Number of elements returned.
hasNext  Whether additional elements are available after this set.
content  Array of JSON objects, such as accounts or transactions, for the requested page number.

For example:

				
					{
  "totalElements": 10,
  "totalPages": 1,
  "number": 1,
  "numberOfElements": 10,
  "hasNext": true,
  "content": [
    {
      "createdAt": "2021-07-08T20:56:35.219Z",
      "updatedAt": "2021-07-10T12:35:22.217Z",
      "id": "B08P316F",
      "requestorId": "KNLOPBHZYT",
      "businessAccountId": "KNLOPBHZYT",
      "clientId": "C12X896Y",
      "businessRefId": "RECIP001",
      "createdSource": "SDK iOS",
      "firstName": "John",
      "middleName": "null",
      "lastName": "Smith",
      "secondLastName": "null",
      "email": "jsmith@xyz.com",
      "phoneNumber": "9055621258",
      "nationality": "Canadian",
      "dateOfBirth": "1970-07-08",
      "additionalInformation": "null",
      "recipientType": "INDIVIDUAL",
      "businessName": "null"
    }
  ]
}

Errors

In addition to detailed error messaging, RocketKOR uses standard HTTP response codes to indicate the status of a request. In general, codes can indicate a successful response (2xx range), a failed response due to the content or structure of the request (4xx range), or a failed response due to an error on the RocketKOR server (5xx range). Most failed responses fall in the 4xx range due to missing/incorrect request parameters or missing/invalid authentication information.

Common HTTP Response Codes

200 OK The request was successful.

201 OK The request was successful and resulted in the creation of a resource.

400 Bad Request The request could not be processed due to missing or incorrect information (for example, a required parameter is missing or a value is entered incorrectly).

401 Unauthorized The API key is missing or invalid.

403 Forbidden The API key doesn’t have the required permissions to perform the request.

404 Not Found The requested resource or endpoint can’t be found.

500 Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.