Skip to content

Instantly share code, notes, and snippets.

@sadick254

sadick254/gist:688b8b284009d545e657accc46b6784d

Created November 1, 2023 07:23
Show Gist options
  • Save sadick254/688b8b284009d545e657accc46b6784d to your computer and use it in GitHub Desktop.
Save sadick254/688b8b284009d545e657accc46b6784d to your computer and use it in GitHub Desktop.
Download ZIP
kra.collection.json
Raw
gistfile1.txt
{
"info": {
"_postman_id": "aa2c06b6-d91e-49f8-924e-6f55cebf0650",
"name": "TLIP API KRA",
"description": "Global Trade and Supply Chain",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "5475691",
"_collection_link": "https://lunar-moon-491203.postman.co/workspace/TLIP~72f3d10b-4374-4f37-9afa-076cc7b73433/collection/30834798-aa2c06b6-d91e-49f8-924e-6f55cebf0650?action=share&source=collection_link&creator=5475691"
},
"item": [
{
"name": "Authentication",
"item": [
{
"name": "login",
"item": [
{
"name": "verify",
"item": [
{
"name": "check",
"item": [
{
"name": "Check if a verification for a login is complete",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"{{identityId}}\",\n \"verificationType\": \"email\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/verify/check",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify",
"check"
]
}
},
"response": [
{
"name": "Response to check if a verification has completed.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"verificationType\": \"email\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/verify/check?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify",
"check"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"verified\": \"<boolean>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"verificationType\": \"email\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/verify/check?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify",
"check"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"verificationType\": \"email\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/verify/check?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify",
"check"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Send verification for a created login",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"{{identityId}}\",\n \"verificationType\": \"email\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/verify",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify"
]
}
},
"response": [
{
"name": "The rest request ended in success with no data.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"verificationType\": \"email\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/verify?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"verificationType\": \"email\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/verify?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"verificationType\": \"email\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/verify?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Confirm verification details for a created login",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/login/verify?identity={{identityId}}&confirm=d38ad44734780fa60d5efdeaa9cdb097536752f4d8d3deead95f60e7d8d039c2&type=email",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify"
],
"query": [
{
"key": "identity",
"value": "{{identityId}}",
"description": "The identity verify the login with."
},
{
"key": "confirm",
"value": "d38ad44734780fa60d5efdeaa9cdb097536752f4d8d3deead95f60e7d8d039c2",
"description": "The data to confirm the verification."
},
{
"key": "type",
"value": "email"
}
]
}
},
"response": [
{
"name": "The rest request ended in success with no data.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/login/verify?identity=<string>&confirm=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify"
],
"query": [
{
"key": "identity",
"value": "<string>",
"description": "The identity verify the login with."
},
{
"key": "confirm",
"value": "<string>",
"description": "The data to confirm the verification."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/login/verify?identity=<string>&confirm=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify"
],
"query": [
{
"key": "identity",
"value": "<string>",
"description": "The identity verify the login with."
},
{
"key": "confirm",
"value": "<string>",
"description": "The data to confirm the verification."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/login/verify?identity=<string>&confirm=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"verify"
],
"query": [
{
"key": "identity",
"value": "<string>",
"description": "The identity verify the login with."
},
{
"key": "confirm",
"value": "<string>",
"description": "The data to confirm the verification."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "refresh",
"item": [
{
"name": "Refresh the current login token",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" const res = pm.response.json();",
" pm.collectionVariables.set(\"authToken\", res.token);",
" pm.collectionVariables.set(\"identityId\", res.identity);",
" pm.environment.set(\"authToken\", res.token);",
" pm.environment.set(\"identityId\", res.identity);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "x-api-key",
"type": "string"
},
{
"key": "value",
"value": "{{apiKey}}",
"type": "string"
},
{
"key": "in",
"value": "query",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"{{identityId}}\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/refresh",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"refresh"
]
}
},
"response": [
{
"name": "The response to a refresh login.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/refresh?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"refresh"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"identity\": \"did:iota:52uiLLNCDREc2EM5C3nMstvtX2Q9g6b4x8ux7dJZk8Dz\",\n \"twoFactorEnabled\": false,\n \"verifiedEmail\": false,\n \"role\": \"organization\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6aW90YTo1MnVpTExOQ0RSRWMyRU01QzNuTXN0dnRYMlE5ZzZiNHg4dXg3ZEpaazhEeiIsInRlbmFudElkIjoiZjk0MjU2NGYwMGM4N2JhZjg4YmE0OWVmM2Y2MjJjN2U0OTcxNTYxYmU3ZjUzZjExYzJkMDYxYzdiYzMwMmMyZCIsImlhdCI6MTY4OTYxODkxMiwiZXhwIjoxNjg5NjIyNTEyfQ.dwHzrHALkvvlKKP2__dlK8iWGtaeX9CyxXp6ObSu-V8\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/refresh?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"refresh"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/refresh?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"refresh"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "password",
"item": [
{
"name": "Update the password for the login",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"{{identityId}}\",\n \"enableDisable\": \"true\",\n \"passwordHash\": \"{{pwHash}}\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/password",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"password"
]
}
},
"response": [
{
"name": "The rest request ended in success with no data.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/password?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"password"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/password?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"password"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/password?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"password"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Send Reset Password",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"{{emailAddress}}\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/account/send-password-reset",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"account",
"send-password-reset"
]
}
},
"response": [
{
"name": "The rest request ended in success with no data.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/password?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"password"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/password?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"password"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/password?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"password"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "email",
"item": [
{
"name": "Update the e-mail for the login",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"{{identityId}}\",\n \"enableDisable\": \"true\",\n \"passwordHash\": \"2bc63858d592c562bc93becaa39b336efbaf49eb066b6b109a68fac520a2c187\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/email",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"email"
]
}
},
"response": [
{
"name": "The rest request ended in success with no data.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/email?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"email"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/email?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"email"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/email?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"email"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "2fa",
"item": [
{
"name": "toggle",
"item": [
{
"name": "Enable or disable the two factor authentication",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"{{identityId}}\",\n \"enableDisable\": false,\n \"passwordHash\": \"{{passwordHash}}\",\n \"pin\": \"548006\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/2fa/toggle",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"2fa",
"toggle"
]
}
},
"response": [
{
"name": "The rest request ended in success with no data.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/2fa/toggle?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"2fa",
"toggle"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/2fa/toggle?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"2fa",
"toggle"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"enableDisable\": \"<boolean>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/2fa/toggle?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"2fa",
"toggle"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "create",
"item": [
{
"name": "Create two-factor authentication for a login",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"{{identityId}}\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/2fa/create",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"2fa",
"create"
]
}
},
"response": [
{
"name": "The response to a create login request.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/2fa/create?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"2fa",
"create"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"twoFactorSecret\": \"5CXYXWCAWICOFZNCPE5Q\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/2fa/create?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"2fa",
"create"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/2fa/create?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"2fa",
"create"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "Create two-factor authentication for a login",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "{{token}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"{{identityId}}\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/2fa/create",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"2fa",
"create"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "vary",
"value": "Origin, accept-encoding"
},
{
"key": "access-control-allow-credentials",
"value": "true"
},
{
"key": "access-control-expose-headers",
"value": "Content-Disposition"
},
{
"key": "content-type",
"value": "application/json; charset=utf-8"
},
{
"key": "content-length",
"value": "42"
},
{
"key": "Date",
"value": "Mon, 19 Jun 2023 17:30:07 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Keep-Alive",
"value": "timeout=72"
}
],
"cookie": [],
"body": "{\n \"twoFactorSecret\": \"5CXYXWCAWICOFZNCPE5Q\"\n}"
}
]
}
]
}
]
},
{
"name": "invite",
"item": [
{
"name": "Get list of pending user invites",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/organization/{{identityId}}/pending-invites",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"organization",
"{{identityId}}",
"pending-invites"
]
},
"description": "console.log({ verifyUrl })"
},
"response": []
},
{
"name": "Get the list of users in an organisation",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/users",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"users"
]
},
"description": "console.log({ verifyUrl })"
},
"response": []
},
{
"name": "Invite Users",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": [\"[email protected]\", \"[email protected]\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/invite/user",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"invite",
"user"
]
},
"description": "console.log({ verifyUrl })"
},
"response": []
},
{
"name": "Invite authority",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"[email protected]\",\n \"name\": \"Border Agent\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/invite/authority",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"invite",
"authority"
]
},
"description": "console.log({ verifyUrl })"
},
"response": []
}
]
},
{
"name": "apikey",
"item": [
{
"name": "Generate api key",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/apiKey/{{identityId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"apiKey",
"{{identityId}}"
]
}
},
"response": []
}
]
},
{
"name": "Login with an identity",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" const res = pm.response.json();",
" pm.collectionVariables.set(\"token\", res.token);",
" pm.collectionVariables.set(\"identityId\", res.identity);",
" pm.environment.set(\"token\", res.token);",
" pm.environment.set(\"identityId\", res.identity);",
"}",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "x-api-key",
"type": "string"
},
{
"key": "value",
"value": "{{apiKey}}",
"type": "string"
},
{
"key": "in",
"value": "query",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"{{emailAddress}}\",\n \"passwordHash\": \"{{pwHash}}\",\n \"pin\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login"
]
}
},
"response": [
{
"name": "The response to a login request.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"<string>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"identity\": \"<string>\",\n \"twoFactorRequired\": \"<boolean>\",\n \"twoFactorEnabled\": \"<boolean>\",\n \"verifiedEmail\": \"<boolean>\",\n \"token\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"<string>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"<string>\",\n \"passwordHash\": \"<string>\",\n \"pin\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Create a login with an identity",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" const res = pm.response.json();",
" pm.collectionVariables.set(\"token\", res.token);",
" pm.collectionVariables.set(\"identityId\", res.identity);",
" pm.environment.set(\"token\", res.token);",
" pm.environment.set(\"identityId\", res.identity);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"{{emailAddress}}\",\n \"password\": \"{{password}}\",\n \"role\": \"organization\",\n \"name\": \"Demo Org\"\n}\n",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/create",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"create"
]
}
},
"response": [
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"<string>\",\n \"password\": \"<string>\",\n \"role\": \"organization\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/create?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"create"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"<string>\",\n \"password\": \"<string>\",\n \"role\": \"organization\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/create?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"create"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "Create admin Res",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"emailAddress\": \"[email protected]\",\n \"password\": \"Password@1234\",\n \"role\": \"organization\",\n \"name\": \"Victor One\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/login/create",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"login",
"create"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "vary",
"value": "Origin, accept-encoding"
},
{
"key": "access-control-allow-credentials",
"value": "true"
},
{
"key": "access-control-expose-headers",
"value": "Content-Disposition"
},
{
"key": "set-cookie",
"value": "access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6aW90YTo2VWZxRVg3V2ZCa3NpQWN4M1hmV0dVaFlCYXVnaHV6N1NDWTFFY2NOWHdIMiIsInRlbmFudElkIjoiNzhmMzM0ZTVlODQ4MGI4OGE4NjMxMWI5N2Q5YjZmN2Q2NDNjNGI2NzU5NjEwMzNhZGQ0ZTBkOGMwOWZhNDA3OSIsImlhdCI6MTY4NzgwMTA2OCwiZXhwIjoxNjg3ODA0NjY4fQ.yuXReztQdMUMUQAYDqWFYr2XcCU3VIh_aomB2-vHvF4; Secure; HttpOnly; SameSite=None; Path=/"
},
{
"key": "content-type",
"value": "application/json; charset=utf-8"
},
{
"key": "content-length",
"value": "724"
},
{
"key": "Date",
"value": "Mon, 26 Jun 2023 17:37:48 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Keep-Alive",
"value": "timeout=72"
}
],
"cookie": [],
"body": "{\n \"recoveryPhrase\": \"crumble describe frost broccoli must render crazy crack memory ignore surge hockey fork slab setup sheriff road time fade sketch arrive hidden skin net\",\n \"identity\": \"did:iota:6UfqEX7WfBksiAcx3XfWGUhYBaughuz7SCY1EccNXwH2\",\n \"publicKey\": \"f89a17be5854f112790df8c49b424424f4234fbb1ef2f58de178a3358059f69d\",\n \"privateKey\": \"c5017ed4f265044d4e5e5299a2696f32e553880fcaba024d88dfe236ed524b6b\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6aW90YTo2VWZxRVg3V2ZCa3NpQWN4M1hmV0dVaFlCYXVnaHV6N1NDWTFFY2NOWHdIMiIsInRlbmFudElkIjoiNzhmMzM0ZTVlODQ4MGI4OGE4NjMxMWI5N2Q5YjZmN2Q2NDNjNGI2NzU5NjEwMzNhZGQ0ZTBkOGMwOWZhNDA3OSIsImlhdCI6MTY4NzgwMTA2OCwiZXhwIjoxNjg3ODA0NjY4fQ.yuXReztQdMUMUQAYDqWFYr2XcCU3VIh_aomB2-vHvF4\"\n}"
}
]
}
]
},
{
"name": "token",
"item": [
{
"name": "{identity}",
"item": [
{
"name": "{id}",
"item": [
{
"name": "Revoke an authentication token",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/token/{{identityId}}/b61d730a449039d6645ef8469ec8acda95073cec84b8380fdedef4ce54aeb7ab",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token",
"{{identityId}}",
"b61d730a449039d6645ef8469ec8acda95073cec84b8380fdedef4ce54aeb7ab"
]
}
},
"response": [
{
"name": "The rest request ended in success with no data.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/token/:identity/:id?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token",
":identity",
":id"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "identity"
},
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/token/:identity/:id?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token",
":identity",
":id"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "identity"
},
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/token/:identity/:id?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token",
":identity",
":id"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "identity"
},
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "List the authentication tokens",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/token/{{identityId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token",
"{{identityId}}"
]
}
},
"response": [
{
"name": "The response to a list token request.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/token/:identity?cursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token",
":identity"
],
"query": [
{
"key": "cursor",
"value": "<string>",
"description": "The cursor for paging."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "identity"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"tokens\": [\n {\n \"id\": \"<string>\",\n \"created\": \"<number>\",\n \"name\": \"<string>\",\n \"expires\": \"<number>\"\n },\n {\n \"id\": \"<string>\",\n \"created\": \"<number>\",\n \"name\": \"<string>\",\n \"expires\": \"<number>\"\n }\n ],\n \"cursor\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/token/:identity?cursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token",
":identity"
],
"query": [
{
"key": "cursor",
"value": "<string>",
"description": "The cursor for paging."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "identity"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/authentication/token/:identity?cursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token",
":identity"
],
"query": [
{
"key": "cursor",
"value": "<string>",
"description": "The cursor for paging."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "identity"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Create an authentication token",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" const res = pm.response.json();",
" pm.collectionVariables.set(\"token\", res.token);",
" pm.environment.set(\"token\", res.token);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"{{identityId}}\",\n \"name\": \"permanent\",\n \"ttl\": \"\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/token",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token"
]
}
},
"response": [
{
"name": "The response to a create token request.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"name\": \"<string>\",\n \"ttl\": \"<number>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/token?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"<string>\",\n \"created\": \"<number>\",\n \"token\": \"<string>\",\n \"expires\": \"<number>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"name\": \"<string>\",\n \"ttl\": \"<number>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/token?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"name\": \"<string>\",\n \"ttl\": \"<number>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/token?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Authentication token decode",
"request": {
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "x-api-key",
"type": "string"
},
{
"key": "value",
"value": "{{apiKey}}",
"type": "string"
},
{
"key": "in",
"value": "query",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"token\": \"{{token}}\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/token/decode",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token",
"decode"
]
}
},
"response": [
{
"name": "The response to a create token request.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"name\": \"<string>\",\n \"ttl\": \"<number>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/token?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"id\": \"<string>\",\n \"created\": \"<number>\",\n \"token\": \"<string>\",\n \"expires\": \"<number>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"name\": \"<string>\",\n \"ttl\": \"<number>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/token?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identity\": \"<string>\",\n \"name\": \"<string>\",\n \"ttl\": \"<number>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/authentication/token?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"authentication",
"token"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "List Identities",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/identities",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"identities"
]
}
},
"response": [
{
"name": "List Identities",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/identities",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"identities"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "vary",
"value": "Origin, accept-encoding"
},
{
"key": "access-control-allow-credentials",
"value": "true"
},
{
"key": "access-control-expose-headers",
"value": "Content-Disposition"
},
{
"key": "content-type",
"value": "application/json; charset=utf-8"
},
{
"key": "content-length",
"value": "236"
},
{
"key": "Date",
"value": "Sat, 28 Oct 2023 19:23:28 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Keep-Alive",
"value": "timeout=72"
}
],
"cookie": [],
"body": "{\n \"identities\": [\n {\n \"emailAddress\": \"[email protected]\",\n \"identity\": \"did:iota:5qKL4aNd4PQs5Hrd4ASmCEEFUhjnpS4CBr6WdLDfQFJ2\"\n },\n {\n \"emailAddress\": \"[email protected]\",\n \"identity\": \"did:iota:9cMkjocG16NN3Pcmp8AK9zu1PFMfpVH9S99DGudsM5KW\"\n }\n ]\n}"
}
]
}
]
},
{
"name": "Document types",
"item": [
{
"name": "{id}",
"item": [
{
"name": "Update document types",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/document-types/{{documentCode}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types",
"{{documentCode}}"
]
}
},
"response": [
{
"name": "The rest request ended in created response.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/document-types/:id?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types",
":id"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"statusCode\": \"<number>\",\n \"headers\": {\n \"location\": \"<string>\"\n }\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/document-types/:id?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types",
":id"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/document-types/:id?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types",
":id"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Delete a document type",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types/{{documentCode}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types",
"{{documentCode}}"
]
}
},
"response": [
{
"name": "The rest request ended in success with no data.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types/:id?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types",
":id"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types/:id?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types",
":id"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types/:id?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types",
":id"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Add document types",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"code\": \"4545\",\n \"identifierField\": \"COE-4545\",\n \"name\": \"Certificate of Export\",\n \"uri\": \"COE:4545\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/document-types",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
]
}
},
"response": [
{
"name": "The rest request ended in created response.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/document-types?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"statusCode\": \"<number>\",\n \"headers\": {\n \"location\": \"<string>\"\n }\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/document-types?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/document-types?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "List of document types",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" const res = pm.response.json();",
" if (res.items.length >= 1) {",
" pm.collectionVariables.set(\"documentCode\", res.items[0].code);",
" pm.environment.set(\"documentCode\", res.items[0].code);",
" }",
"}",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
]
}
},
"response": [
{
"name": "Document types list response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"items\": [\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n },\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n }\n ],\n \"nextPageCursor\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Search document types",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" const res = pm.response.json();",
" if (res.items.length >= 1) {",
" pm.collectionVariables.set(\"documentCode\", res.items[0].code);",
" pm.environment.set(\"documentCode\", res.items[0].code);",
" }",
"}",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?search=4545",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "search",
"value": "4545"
}
]
}
},
"response": [
{
"name": "Document types list response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"items\": [\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n },\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n }\n ],\n \"nextPageCursor\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Identifier types",
"item": [
{
"name": "List of identifier types",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/identifier-types",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"identifier-types"
]
}
},
"response": []
},
{
"name": "create identifier",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"ucr\",\n \"uri\": \"unece:globalId\",\n \"name\": \"UCR\",\n \"dataType\": \"https://shema.org/Text\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/identifier-types",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"identifier-types"
]
}
},
"response": []
}
]
},
{
"name": "Event types",
"item": [
{
"name": "List of event types",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" const res = pm.response.json();",
" if (res.eventTypes.length >= 1) {",
" pm.collectionVariables.set(\"eventTypeId\", res.items[0].id);",
" pm.environment.set(\"eventTypeId\", res.items[0].id);",
" }",
"}",
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/event-types",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"event-types"
]
}
},
"response": [
{
"name": "Document types list response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"items\": [\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n },\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n }\n ],\n \"nextPageCursor\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Add event types",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"certificate-of-origin\",\n \"name\": \"Certificate of Origin\",\n \"uri\": \"https://w3id.org/open-gtsc/kra_release_event\",\n \"createName\": \"Request Certificate of Origin\",\n \"inProgressName\": \"Certificate of Origin Requested\",\n \"documentType\": \"{{documentType}}\",\n \"documentTypeNumber\": {{documentTypeNumber}}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/event-types",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"event-types"
]
}
},
"response": [
{
"name": "Document types list response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"items\": [\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n },\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n }\n ],\n \"nextPageCursor\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Edit event type",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"certificate-of-export\",\n \"name\": \"Certificate of Export\",\n \"uri\": \"https://w3id.org/open-gtsc/kra_release_event\",\n \"createName\": \"Request Certificate of Export\",\n \"inProgressName\": \"Certificate of Export Requested\",\n \"documentType\": \"certificateOfExport\",\n \"documentTypeNumber\": 1002\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/event-types/{{eventTypeId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"event-types",
"{{eventTypeId}}"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from.",
"disabled": true
}
]
}
},
"response": [
{
"name": "Document types list response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"items\": [\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n },\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n }\n ],\n \"nextPageCursor\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Delete event type",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/event-types/{{eventTypeId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"event-types",
"{{eventTypeId}}"
]
}
},
"response": [
{
"name": "Document types list response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"items\": [\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n },\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n }\n ],\n \"nextPageCursor\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Matrix",
"item": [
{
"name": "List matrix",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/matrix-display",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"matrix-display"
]
}
},
"response": [
{
"name": "Document types list response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"items\": [\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n },\n {\n \"id\": \"<string>\",\n \"uri\": {},\n \"name\": \"<string>\",\n \"dataType\": {}\n }\n ],\n \"nextPageCursor\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/document-types?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"document-types"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get identitifer types from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Consignments",
"item": [
{
"name": "{itemId}",
"item": [
{
"name": "identifiers",
"item": [
{
"name": "Add an identifier to a consignment",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"aliasType\": \"JCP122\",\n \"aliasId\": \"ucr\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignments/{{consignmentId}}/identifiers",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"{{consignmentId}}",
"identifiers"
]
}
},
"response": [
{
"name": "The rest request ended in created response.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"aliasType\": \"<string>\",\n \"aliasId\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:itemId/identifiers?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":itemId",
"identifiers"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "itemId"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"statusCode\": \"<number>\",\n \"headers\": {\n \"location\": \"<string>\"\n }\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"aliasType\": \"<string>\",\n \"aliasId\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:itemId/identifiers?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":itemId",
"identifiers"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "itemId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"aliasType\": \"<string>\",\n \"aliasId\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:itemId/identifiers?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":itemId",
"identifiers"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "itemId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
}
]
},
{
"name": "{consignmentId}",
"item": [
{
"name": "json-ld",
"item": [
{
"name": "Get a consignment as JSON-LD",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/{{consignmentId}}/json-ld",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"{{consignmentId}}",
"json-ld"
]
}
},
"response": [
{
"name": "The details for a Json LD get response.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId/json-ld?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId",
"json-ld"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"@context\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId/json-ld?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId",
"json-ld"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId/json-ld?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId",
"json-ld"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "The resource you tried to access does not exist, see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId/json-ld?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId",
"json-ld"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\",\n \"notFoundId\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Get a consignment",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/urn:ucr:ucr-001",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"urn:ucr:ucr-001"
]
}
},
"response": [
{
"name": "The response to get a consignment.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\",\n \"created\": \"<number>\",\n \"updated\": \"<number>\",\n \"identifiers\": [\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"events\": \"<array>\",\n \"documents\": \"<array>\",\n \"destinationCountry\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Get a consignment documents",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/{{consignmentId}}/documents",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"{{consignmentId}}",
"documents"
]
}
},
"response": [
{
"name": "The response to get a consignment.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\",\n \"created\": \"<number>\",\n \"updated\": \"<number>\",\n \"identifiers\": [\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"events\": \"<array>\",\n \"documents\": \"<array>\",\n \"destinationCountry\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Create Event consignment",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
"const now = Date.now();",
"pm.environment.set('currenttime', now);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"itemId\": \"urn:ucr:ucr-001\",\n \"type\": \"portRelease\",\n \"startTime\": {{currenttime}},\n \"endTime\": {{currenttime}},\n \"identity\": \"{{identityId}}\"\n // \"completionStatus\": \"rejected\" // \"complete\" | \"issued\" | \"approved\" | \"rejected\" | \"failed\" | \"other\"\n // \"action\": \"Request\", // Add\n // \"fail\": true,\n // \"location\": {\n // \"name\": \"Nairobi\",\n // \"longitude\": 123,\n // \"latitude\": 456\n // },\n // \"documentRevision\": 6\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignments/urn:ucr:ucr-001/events",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"urn:ucr:ucr-001",
"events"
]
}
},
"response": [
{
"name": "The response to get a consignment.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\",\n \"created\": \"<number>\",\n \"updated\": \"<number>\",\n \"identifiers\": [\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"events\": \"<array>\",\n \"documents\": \"<array>\",\n \"destinationCountry\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Get consignment events",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
"const now = Date.now();",
"pm.environment.set('currenttime', now);"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"itemId\": \"{{consignmentId}}\",\n \"type\": \"{{documentType}}\",\n \"startTime\": {{currenttime}},\n \"endTime\": {{currenttime}},\n \"identity\": \"{{identityId}}\",\n \"completionStatus\": \"rejected\" // \"complete\" | \"issued\" | \"approved\" | \"rejected\" | \"failed\" | \"other\"\n // \"action\": \"Request\", // Add\n // \"fail\": true,\n // \"location\": {\n // \"name\": \"Nairobi\",\n // \"longitude\": 123,\n // \"latitude\": 456\n // },\n // \"documentRevision\": 6\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignments/{{consignmentId}}/events",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"{{consignmentId}}",
"events"
]
}
},
"response": [
{
"name": "The response to get a consignment.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\",\n \"created\": \"<number>\",\n \"updated\": \"<number>\",\n \"identifiers\": [\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"events\": \"<array>\",\n \"documents\": \"<array>\",\n \"destinationCountry\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Get consignments",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments"
]
}
},
"response": [
{
"name": "The rest request ended in success with no data.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get consignments from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get consignments from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments?nextPageCursor=<string>&x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments"
],
"query": [
{
"key": "nextPageCursor",
"value": "<string>",
"description": "The cursor offset to get consignments from."
},
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Consignment",
"item": [
{
"name": "document",
"item": [
{
"name": "Upload and associate a binary document with a consignment",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" const res = pm.response.json();",
" pm.collectionVariables.set(\"documentId\", res.id);",
" pm.environment.set(\"documentId\", res.id);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"binaryData\": \"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pgo8cm9vdD48dmVyc2lvbj4xPC92ZXJzaW9uPjwvcm9vdD4=\",\n \"completionStatus\": \"issued\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment/{{consignmentId}}/document/{{documentCode}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment",
"{{consignmentId}}",
"document",
"{{documentCode}}"
]
}
},
"response": [
{
"name": "The response to a document upload.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"binaryData\": \"<string>\",\n \"completionStatus\": \"rejected\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment/:consignmentId/document/:documentType?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment",
":consignmentId",
"document",
":documentType"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
},
{
"key": "documentType"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"revision\": \"<number>\",\n \"fingerPrint\": \"<string>\",\n \"properties\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n },\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n }\n ],\n \"identifiers\": [\n {\n \"id\": \"<string>\",\n \"properties\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n },\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"properties\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n },\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n }\n ]\n }\n ],\n \"events\": [\n {\n \"id\": \"<string>\",\n \"identity\": \"<string>\",\n \"itemId\": \"<string>\",\n \"startTime\": \"<number>\",\n \"type\": \"<string>\",\n \"endTime\": \"<number>\",\n \"completionStatus\": \"complete\",\n \"properties\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n },\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n }\n ]\n },\n {\n \"id\": \"<string>\",\n \"identity\": \"<string>\",\n \"itemId\": \"<string>\",\n \"startTime\": \"<number>\",\n \"type\": \"<string>\",\n \"endTime\": \"<number>\",\n \"completionStatus\": \"other\",\n \"properties\": [\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n },\n {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"value\": {\n \"description\": \"The value for the item.\"\n }\n }\n ]\n }\n ]\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"binaryData\": \"<string>\",\n \"completionStatus\": \"rejected\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment/:consignmentId/document/:documentType?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment",
":consignmentId",
"document",
":documentType"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
},
{
"key": "documentType"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"binaryData\": \"<string>\",\n \"completionStatus\": \"rejected\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment/:consignmentId/document/:documentType?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment",
":consignmentId",
"document",
":documentType"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
},
{
"key": "documentType"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "Create a new consignment",
"event": [
{
"listen": "test",
"script": {
"exec": [
"if (pm.response.code === 200) {",
" const res = pm.response.json();",
" pm.collectionVariables.set(\"consignmentId\", res.consignmentId);",
" pm.environment.set(\"consignmentId\", res.consignmentId);",
"}"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"oh\",\n \"identifier\": \"CIN-002\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
]
}
},
"response": [
{
"name": "The response to a consignment creation.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Search consignment",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignment/search?value=UK",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment",
"search"
],
"query": [
{
"key": "value",
"value": "UK"
}
]
}
},
"response": [
{
"name": "The response to a consignment creation.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Share consignment",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"identity\": \"did:iota:5p4ym2Rmj8VsUcgZswjQwES4NXeefRexccEehMjqQHwt\",\n\t\"type\": \"READ\",\n\t\"properties\": [\n\t\t{\n\t\t\t\"type\": \"DATA\",\n\t\t\t\"value\": \"all\",\n\t\t\t\"ttl\": 16899343438\n\t\t}\n\t]\n}\n"
},
"url": {
"raw": "{{baseUrl}}/permissions/urn:ucr:ucr-002",
"host": [
"{{baseUrl}}"
],
"path": [
"permissions",
"urn:ucr:ucr-002"
]
}
},
"response": [
{
"name": "The response to a consignment creation.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Remove consignment permissions",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"identity\": \"\"\n}\n"
},
"url": {
"raw": "{{baseUrl}}/permissions/urn:ucr:ucr-002",
"host": [
"{{baseUrl}}"
],
"path": [
"permissions",
"urn:ucr:ucr-002"
]
}
},
"response": [
{
"name": "The response to a consignment creation.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Get consignment permissions",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/permissions/urn:ucr:ucr-002",
"host": [
"{{baseUrl}}"
],
"path": [
"permissions",
"urn:ucr:ucr-002"
]
}
},
"response": [
{
"name": "The response to a consignment creation.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"identifierType\": \"<string>\",\n \"identifier\": \"<string>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/tlip/consignment?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignment"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
},
{
"name": "TLIP Connector",
"item": [
{
"name": "Notify(Create consignment)",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/{{consignmentId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"{{consignmentId}}"
]
}
},
"response": [
{
"name": "The response to get a consignment.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\",\n \"created\": \"<number>\",\n \"updated\": \"<number>\",\n \"identifiers\": [\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"events\": \"<array>\",\n \"documents\": \"<array>\",\n \"destinationCountry\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Document Request",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/{{consignmentId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"{{consignmentId}}"
]
}
},
"response": [
{
"name": "The response to get a consignment.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\",\n \"created\": \"<number>\",\n \"updated\": \"<number>\",\n \"identifiers\": [\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"events\": \"<array>\",\n \"documents\": \"<array>\",\n \"destinationCountry\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Document Add",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/{{consignmentId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"{{consignmentId}}"
]
}
},
"response": [
{
"name": "The response to get a consignment.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\",\n \"created\": \"<number>\",\n \"updated\": \"<number>\",\n \"identifiers\": [\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"events\": \"<array>\",\n \"documents\": \"<array>\",\n \"destinationCountry\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Consignments",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/{{consignmentId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"{{consignmentId}}"
]
}
},
"response": [
{
"name": "The response to get a consignment.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\",\n \"created\": \"<number>\",\n \"updated\": \"<number>\",\n \"identifiers\": [\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"events\": \"<array>\",\n \"documents\": \"<array>\",\n \"destinationCountry\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
},
{
"name": "Consignment Documents",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "x-api-key",
"value": "{{apiKey}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/{{consignmentId}}",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
"{{consignmentId}}"
]
}
},
"response": [
{
"name": "The response to get a consignment.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"consignmentId\": \"<string>\",\n \"created\": \"<number>\",\n \"updated\": \"<number>\",\n \"identifiers\": [\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n },\n {\n \"type\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"events\": \"<array>\",\n \"documents\": \"<array>\",\n \"destinationCountry\": \"<string>\"\n}"
},
{
"name": "Something went wrong with the request see the error field for more details.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
},
{
"name": "You are not authorized to use the API or no credentials were supplied.",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tlip/consignments/:consignmentId?x-api-key=<API Key>",
"host": [
"{{baseUrl}}"
],
"path": [
"tlip",
"consignments",
":consignmentId"
],
"query": [
{
"key": "x-api-key",
"value": "<API Key>",
"description": "Added as a part of security scheme: apikey"
}
],
"variable": [
{
"key": "consignmentId"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"error\": \"<string>\"\n}"
}
]
}
]
}
],
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{token}}",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
}
],
"variable": [
{
"key": "baseUrl",
"value": "https://tlip-test-api.gtsc.io",
"type": "string"
},
{
"key": "apiKey",
"value": "a9497e5ea2499b1db75b8bfde54c0eab",
"type": "string"
},
{
"key": "token",
"value": "",
"type": "string"
},
{
"key": "consignmentId",
"value": "",
"type": "string"
},
{
"key": "identityId",
"value": "",
"type": "string"
},
{
"key": "documentCode",
"value": "",
"type": "string"
},
{
"key": "eventTypeId",
"value": "",
"type": "string"
},
{
"key": "authToken",
"value": ""
},
{
"key": "documentId",
"value": ""
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment