API tools faq
paste
Guest User

Untitled

a guest
Nov 12th, 2019
96
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 89.83 KB | None | 0 0
raw download clone embed print report
  1. {
  2. "openapi": "3.0.1",
  3. "info": {
  4. "title": "Deep Labs Platform",
  5. "version": "2.0.0",
  6. "description": "## Introduction\n\nThis collection of APIs are for communicating with the Deep Labs Platform.\n\nIntegrating directly with the APIs in this documentation is recommended only for advanced users that want to write their own API clients. If you want to get started quickly or for a simpler integration, consider using the [available official clients.](https://github.com/Deep-Labs)\n\n## Authentication\n\nThe Deep Labs Platform requires authentication using JSON Web Tokens (JWT) to authenticate each request.\n\nGenerating a JWT requires a `client_id` and `client_secret` which can be requested by [contacting support.](mailto:support@deep-labs.com)\n\nFor an example of how to generate a JWT, see the [token endpoint](#tag/token).\n\nFor REST API access the JWT must be sent with the request in an `Authorization` header, for example:\n```\ncurl -H \"Authorization: Bearer <token>\"\n```\n\nFor Websocket connections the JWT must be sent in a Secure Cookie under an `access_token` key. A strict Cross-Origin Resource Sharing (CORS) filtering is implemented, and as such the requester's Origin must be whitelisted.\n\nWhen dealing with authentication tokens you should keep in mind that tokens are like passwords. **Never** share tokens with untrusted parties.\n\n<!-- ReDoc-Inject: <security-definitions> -->\n"
  7. },
  8. "servers": [
  9. {
  10. "url": "https://api.production.deep-labs.io/{version}",
  11. "description": "Production",
  12. "variables": {
  13. "version": {
  14. "enum": [
  15. "v2"
  16. ],
  17. "default": "v2"
  18. }
  19. }
  20. }
  21. ],
  22. "tags": [
  23. {
  24. "name": "token"
  25. },
  26. {
  27. "name": "events",
  28. "description": "Events are submitted to the Deep Labs platform as data to be processed for creating a Decision"
  29. },
  30. {
  31. "name": "decisions"
  32. }
  33. ],
  34. "x-tagGroups": [
  35. {
  36. "name": "Deep Identity",
  37. "tags": [
  38. "token",
  39. "events",
  40. "decisions"
  41. ]
  42. }
  43. ],
  44. "paths": {
  45. "/token": {
  46. "post": {
  47. "tags": [
  48. "token"
  49. ],
  50. "summary": "Request a new JWT",
  51. "operationId": "createToken",
  52. "requestBody": {
  53. "content": {
  54. "application/json": {
  55. "schema": {
  56. "$ref": "#/components/schemas/NewTokenRequest"
  57. }
  58. }
  59. }
  60. },
  61. "responses": {
  62. "201": {
  63. "description": "A JWT was created successfully",
  64. "content": {
  65. "application/json": {
  66. "schema": {
  67. "$ref": "#/components/schemas/Token"
  68. }
  69. }
  70. }
  71. },
  72. "400": {
  73. "$ref": "#/components/responses/BadRequest"
  74. },
  75. "401": {
  76. "$ref": "#/components/responses/Unauthorized"
  77. },
  78. "500": {
  79. "$ref": "#/components/responses/InternalServerError"
  80. }
  81. },
  82. "x-code-samples": [
  83. {
  84. "lang": "Shell cURL",
  85. "source": "curl --request POST \\\n --url https://api.production.deep-labs.io/v2/token \\\n --header 'accepts: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\"client_id\":\"bbb343f9-6412-492a-9cc3-6ab34c3baac9\",\"client_secret\":\"juCdLaid9cC4Xm7wdLeffBpze7GjpZlGgoL7nZH3ClPRTl4AaciqbwFsG1Az7LJ2\"}'"
  86. },
  87. {
  88. "lang": "Node.js Request",
  89. "source": "var request = require(\"request\");\n\nvar options = { method: 'POST',\n url: 'https://api.production.deep-labs.io/v2/token',\n headers: \n { accepts: 'application/json',\n 'content-type': 'application/json' },\n body: \n { client_id: 'bbb343f9-6412-492a-9cc3-6ab34c3baac9',\n client_secret: 'juCdLaid9cC4Xm7wdLeffBpze7GjpZlGgoL7nZH3ClPRTl4AaciqbwFsG1Az7LJ2' },\n json: true };\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
  90. }
  91. ]
  92. }
  93. },
  94. "/events": {
  95. "post": {
  96. "tags": [
  97. "events"
  98. ],
  99. "summary": "Create an Event",
  100. "operationId": "createEvent",
  101. "requestBody": {
  102. "content": {
  103. "application/json": {
  104. "schema": {
  105. "$ref": "#/components/schemas/EventBase"
  106. }
  107. }
  108. }
  109. },
  110. "responses": {
  111. "201": {
  112. "description": "Event was successfully created",
  113. "content": {
  114. "application/json": {
  115. "schema": {
  116. "$ref": "#/components/schemas/EventReadOnly"
  117. }
  118. }
  119. }
  120. },
  121. "400": {
  122. "$ref": "#/components/responses/BadRequest"
  123. },
  124. "401": {
  125. "$ref": "#/components/responses/Unauthorized"
  126. },
  127. "422": {
  128. "$ref": "#/components/responses/UnprocessibleEntity"
  129. },
  130. "500": {
  131. "$ref": "#/components/responses/InternalServerError"
  132. }
  133. },
  134. "security": [
  135. {
  136. "Bearer": []
  137. }
  138. ],
  139. "x-code-samples": [
  140. {
  141. "lang": "Shell cURL",
  142. "source": "curl --request POST \\\n --url https://api.production.deep-labs.io/v2/events \\\n --header 'accepts: application/json' \\\n --header 'authorization: Bearer <JWT>' \\\n --header 'content-type: application/json' \\\n --data '{\"type\":\"IDENTITY-DOCUMENT\",\"reference\":\"0c1f1ef9-9243-41fb-a1b0-4062728da7c6\",\"occuredAt\":\"2018-01-01T01:00:00Z\",\"detail\":{\"type\":\"USDriversLicense\",\"images\":[\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOwAAACZCAYAAAAsPNZmQmCC...\",\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANIAAAAzCAYAAADigVZlAAAQ...\"],\"data\":{\"firstName\":\"BOB\",\"surname\":\"JONES\",\"documentNo\":\"D2446378\",\"sex\":\"2\",\"dateOfBirth\":\"01041976\",\"dateOfExpiry\":\"01042019\",\"dateOfIssue\":\"03292014\",\"issuingAuthority\":\"636014\",\"address\":\"123 5TH ST, OAKLAND, CA, 940680000\",\"height\":\"61 in\",\"country\":\"USA\",\"fullName\":\"BOB,LEE,JONES\",\"18thBirthday\":\"(null)\",\"19thBirthday\":\"(null)\",\"21stBirthday\":\"(null)\"}}}'"
  143. },
  144. {
  145. "lang": "Node.js Request",
  146. "source": "var request = require(\"request\");\n\nvar options = { method: 'POST',\n url: 'https://api.production.deep-labs.io/v2/events',\n headers: \n { accepts: 'application/json',\n 'content-type': 'application/json',\n authorization: 'Bearer <JWT>' },\n body: \n { type: 'IDENTITY-DOCUMENT',\n reference: '0c1f1ef9-9243-41fb-a1b0-4062728da7c6',\n occuredAt: '2018-01-01T01:00:00Z',\n detail: \n { type: 'USDriversLicense',\n images: \n [ 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOwAAACZCAYAAAAsPNZmQmCC...',\n 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANIAAAAzCAYAAADigVZlAAAQ...' ],\n data: \n { firstName: 'BOB',\n surname: 'JONES',\n documentNo: 'D2446378',\n sex: '2',\n dateOfBirth: '01041976',\n dateOfExpiry: '01042019',\n dateOfIssue: '03292014',\n issuingAuthority: '636014',\n address: '123 5TH ST, OAKLAND, CA, 940680000',\n height: '61 in',\n country: 'USA',\n fullName: 'BOB,LEE,JONES',\n '18thBirthday': '(null)',\n '19thBirthday': '(null)',\n '21stBirthday': '(null)' } } },\n json: true };\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
  147. }
  148. ]
  149. },
  150. "get": {
  151. "tags": [
  152. "events"
  153. ],
  154. "summary": "Retrieve all Events",
  155. "operationId": "getEvents",
  156. "parameters": [
  157. {
  158. "in": "query",
  159. "name": "type",
  160. "description": "Get all Events by type",
  161. "schema": {
  162. "$ref": "#/components/schemas/EventTypes"
  163. }
  164. },
  165. {
  166. "in": "query",
  167. "name": "reference",
  168. "description": "Get all Events by a reference",
  169. "schema": {
  170. "type": "string",
  171. "format": "uuid"
  172. }
  173. },
  174. {
  175. "in": "query",
  176. "name": "offset",
  177. "description": "The number of Events to skip before starting to return Events",
  178. "schema": {
  179. "type": "string",
  180. "pattern": "^[0-9]*$",
  181. "default": "0"
  182. }
  183. },
  184. {
  185. "in": "query",
  186. "name": "limit",
  187. "description": "The number of Events to return (1-10)",
  188. "schema": {
  189. "type": "string",
  190. "pattern": "^\\b([1-9]|10)\\b$",
  191. "default": "5"
  192. }
  193. }
  194. ],
  195. "responses": {
  196. "200": {
  197. "description": "Success",
  198. "content": {
  199. "application/json": {
  200. "schema": {
  201. "$ref": "#/components/schemas/Events"
  202. }
  203. }
  204. }
  205. },
  206. "401": {
  207. "$ref": "#/components/responses/Unauthorized"
  208. },
  209. "500": {
  210. "$ref": "#/components/responses/InternalServerError"
  211. }
  212. },
  213. "security": [
  214. {
  215. "Bearer": []
  216. }
  217. ],
  218. "x-code-samples": [
  219. {
  220. "lang": "Shell cURL",
  221. "source": "curl --request GET \\\n --url https://api.production.deep-labs.io/v2/events \\\n --header 'authorization: Bearer <JWT>'"
  222. },
  223. {
  224. "lang": "Node.js Request",
  225. "source": "var request = require(\"request\");\n\nvar options = { method: 'GET',\n url: 'https://api.production.deep-labs.io/v2/events',\n headers: { authorization: 'Bearer <JWT>' } };\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
  226. }
  227. ]
  228. }
  229. },
  230. "/events/{id}": {
  231. "get": {
  232. "tags": [
  233. "events"
  234. ],
  235. "summary": "Retrieve an Event",
  236. "operationId": "getEvent",
  237. "parameters": [
  238. {
  239. "name": "id",
  240. "in": "path",
  241. "description": "ID of an existing Event",
  242. "required": true,
  243. "schema": {
  244. "type": "string",
  245. "format": "uuid"
  246. }
  247. }
  248. ],
  249. "responses": {
  250. "200": {
  251. "description": "Success",
  252. "content": {
  253. "application/json": {
  254. "schema": {
  255. "$ref": "#/components/schemas/EventFull"
  256. }
  257. }
  258. }
  259. },
  260. "401": {
  261. "$ref": "#/components/responses/Unauthorized"
  262. },
  263. "404": {
  264. "$ref": "#/components/responses/NotFound"
  265. },
  266. "500": {
  267. "$ref": "#/components/responses/InternalServerError"
  268. }
  269. },
  270. "security": [
  271. {
  272. "Bearer": []
  273. }
  274. ],
  275. "x-code-samples": [
  276. {
  277. "lang": "Shell cURL",
  278. "source": "curl --request GET \\\n --url https://api.production.deep-labs.io/v2/events/%7Bid%7D \\\n --header 'authorization: Bearer <JWT>'"
  279. },
  280. {
  281. "lang": "Node.js Request",
  282. "source": "var request = require(\"request\");\n\nvar options = { method: 'GET',\n url: 'https://api.production.deep-labs.io/v2/events/%7Bid%7D',\n headers: { authorization: 'Bearer <JWT>' } };\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
  283. }
  284. ]
  285. }
  286. },
  287. "/decisions": {
  288. "post": {
  289. "tags": [
  290. "decisions"
  291. ],
  292. "summary": "Create a Decision",
  293. "x-swagger-router-controller": "decisions",
  294. "operationId": "createDecision",
  295. "requestBody": {
  296. "content": {
  297. "application/json": {
  298. "schema": {
  299. "$ref": "#/components/schemas/Request"
  300. }
  301. }
  302. }
  303. },
  304. "responses": {
  305. "201": {
  306. "description": "Success",
  307. "content": {
  308. "application/json": {
  309. "schema": {
  310. "$ref": "#/components/schemas/Decision"
  311. },
  312. "examples": {
  313. "InProgressDecision": {
  314. "$ref": "#/components/examples/InProgressDecision"
  315. },
  316. "CompletedDecision": {
  317. "$ref": "#/components/examples/CompletedDecision"
  318. }
  319. }
  320. }
  321. },
  322. "links": {
  323. "GetDecisionById": {
  324. "operationId": "getDecision",
  325. "parameters": {
  326. "id": "$response.body#/id"
  327. },
  328. "description": "The `id` value returned in the response can be used as the `id` parameter in `GET /decisions/{id}`.\n"
  329. }
  330. }
  331. },
  332. "400": {
  333. "$ref": "#/components/responses/BadRequest"
  334. },
  335. "401": {
  336. "$ref": "#/components/responses/Unauthorized"
  337. },
  338. "409": {
  339. "$ref": "#/components/responses/Conflict"
  340. },
  341. "500": {
  342. "$ref": "#/components/responses/InternalServerError"
  343. }
  344. },
  345. "security": [
  346. {
  347. "Bearer": []
  348. }
  349. ],
  350. "x-code-samples": [
  351. {
  352. "lang": "Shell cURL",
  353. "source": "curl --request POST \\\n --url https://api.production.deep-labs.io/v2/decisions \\\n --header 'accepts: application/json' \\\n --header 'authorization: Bearer <JWT>' \\\n --header 'content-type: application/json' \\\n --data '{\"recipe\":\"0c1f1ef9-9243-41fb-a1b0-4062728da7c6\",\"reference\":\"aa4e2f7c-8de7-439b-8b20-85f357b6fea5\"}'"
  354. },
  355. {
  356. "lang": "Node.js Request",
  357. "source": "var request = require(\"request\");\n\nvar options = { method: 'POST',\n url: 'https://api.production.deep-labs.io/v2/decisions',\n headers: \n { accepts: 'application/json',\n 'content-type': 'application/json',\n authorization: 'Bearer <JWT>' },\n body: \n { recipe: '0c1f1ef9-9243-41fb-a1b0-4062728da7c6',\n reference: 'aa4e2f7c-8de7-439b-8b20-85f357b6fea5' },\n json: true };\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
  358. }
  359. ]
  360. }
  361. },
  362. "/decisions/{id}": {
  363. "get": {
  364. "tags": [
  365. "decisions"
  366. ],
  367. "summary": "Retrieve a Decision",
  368. "x-swagger-router-controller": "decisions",
  369. "operationId": "getDecision",
  370. "parameters": [
  371. {
  372. "name": "id",
  373. "in": "path",
  374. "description": "ID of existing Decision",
  375. "required": true,
  376. "schema": {
  377. "type": "string",
  378. "format": "uuid"
  379. }
  380. }
  381. ],
  382. "responses": {
  383. "200": {
  384. "description": "Success",
  385. "content": {
  386. "application/json": {
  387. "schema": {
  388. "$ref": "#/components/schemas/Decision"
  389. },
  390. "examples": {
  391. "InProgressDecision": {
  392. "$ref": "#/components/examples/InProgressDecision"
  393. },
  394. "CompletedDecision": {
  395. "$ref": "#/components/examples/CompletedDecision"
  396. }
  397. }
  398. }
  399. }
  400. },
  401. "401": {
  402. "$ref": "#/components/responses/Unauthorized"
  403. },
  404. "404": {
  405. "$ref": "#/components/responses/NotFound"
  406. },
  407. "500": {
  408. "$ref": "#/components/responses/InternalServerError"
  409. }
  410. },
  411. "security": [
  412. {
  413. "Bearer": []
  414. }
  415. ],
  416. "x-code-samples": [
  417. {
  418. "lang": "Shell cURL",
  419. "source": "curl --request GET \\\n --url https://api.production.deep-labs.io/v2/decisions/%7Bid%7D \\\n --header 'authorization: Bearer <JWT>'"
  420. },
  421. {
  422. "lang": "Node.js Request",
  423. "source": "var request = require(\"request\");\n\nvar options = { method: 'GET',\n url: 'https://api.production.deep-labs.io/v2/decisions/%7Bid%7D',\n headers: { authorization: 'Bearer <JWT>' } };\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
  424. }
  425. ]
  426. }
  427. }
  428. },
  429. "components": {
  430. "schemas": {
  431. "NewTokenRequest": {
  432. "type": "object",
  433. "properties": {
  434. "client_id": {
  435. "type": "string",
  436. "description": "Unique Client Identifier"
  437. },
  438. "client_secret": {
  439. "type": "string",
  440. "description": "Clients secret"
  441. }
  442. },
  443. "additionalProperties": false,
  444. "required": [
  445. "client_id",
  446. "client_secret"
  447. ],
  448. "example": {
  449. "client_id": "bbb343f9-6412-492a-9cc3-6ab34c3baac9",
  450. "client_secret": "juCdLaid9cC4Xm7wdLeffBpze7GjpZlGgoL7nZH3ClPRTl4AaciqbwFsG1Az7LJ2"
  451. }
  452. },
  453. "Token": {
  454. "type": "object",
  455. "properties": {
  456. "access_token": {
  457. "type": "string",
  458. "description": "JSON Web Token"
  459. },
  460. "expires_in": {
  461. "type": "number",
  462. "description": "Length of time in seconds that token will expire in"
  463. },
  464. "scope": {
  465. "type": "string",
  466. "description": "Space separated string of scopes token has"
  467. },
  468. "token_type": {
  469. "type": "string",
  470. "description": "Type of token"
  471. }
  472. },
  473. "required": [
  474. "access_token",
  475. "expires_in",
  476. "scope",
  477. "token_type"
  478. ],
  479. "example": {
  480. "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik1qRTFRME0wUTBJMU9UTXlNalJFUXpJM016STJOVEJGUmpFMU1VSkJOemhHTUVWQk1qWTVSQSJ9.eyJodHRwczovL2RlZXAtbGFicy9wb2wiOiI1OWNiYjk0M2ZlNTQzYzAwMDEzOWMyNTUiLCJpc3MiOiJodHRwczovL2RlZXAtbGFicy5hdXRoMC5jb20vIiwic3ViIjoiWTVpSHBicjZKNDA1TXRZdHdRUncxczFYc2NGTm1XQ01AY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vYWxwaGEtZGVlcC1sYWJzIiwiaWF0IjoxNTA3MTMwMDU2LCJleHAiOjE1MDcyMTY0NTYsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyJ9.CU14WQhzO6urRnS2R1SIy58RVbwFucU5SNMZAIJvHv4Z--cEV8VquDQmFi-Tj3YzFW9W_jSEMHSEe7cgebZKyrxwXXLKmKxyG_zk99RnXys9mOxOysakPr2IcECW5gqHIqxz7C5GznRSFk778iObRycGYzl4PlQdYJuVMPMd27BzX_AejfznFFb7dTQLdyWF82hlk_SFJjZnO77Vuf0c1egv46HtOHWvu9FqXahDufAP0Nyy5OJ5xT9aAwjudBBaQIDFEDAoDSiSzOTRr-bqXpzxvQEPXNPf8YAXLiVjoYPAYZQOYfLbYat-QxTRWCco4usw3rW0bAAK5YdBYLiscw",
  481. "expires_in": 86400,
  482. "scope": "write:events read:events",
  483. "token_type": "Bearer"
  484. }
  485. },
  486. "Error": {
  487. "type": "object",
  488. "properties": {
  489. "status": {
  490. "description": "Error code",
  491. "type": "integer"
  492. },
  493. "error": {
  494. "description": "Error message",
  495. "type": "string"
  496. }
  497. },
  498. "required": [
  499. "status",
  500. "error"
  501. ]
  502. },
  503. "Events": {
  504. "type": "object",
  505. "properties": {
  506. "events": {
  507. "description": "A collection of Events",
  508. "type": "array",
  509. "items": {
  510. "$ref": "#/components/schemas/EventFull"
  511. }
  512. },
  513. "size": {
  514. "description": "Number of Events in collection",
  515. "type": "integer"
  516. }
  517. },
  518. "required": [
  519. "events",
  520. "size"
  521. ]
  522. },
  523. "EventReadOnly": {
  524. "type": "object",
  525. "properties": {
  526. "id": {
  527. "description": "ID of the created Event",
  528. "type": "string",
  529. "format": "uuid"
  530. }
  531. },
  532. "required": [
  533. "id"
  534. ],
  535. "example": {
  536. "id": "3e4282eb-7b79-4506-b5ee-d8818e6cb73a"
  537. }
  538. },
  539. "EventBase": {
  540. "oneOf": [
  541. {
  542. "$ref": "#/components/schemas/IdentityDocumentEventNew"
  543. },
  544. {
  545. "$ref": "#/components/schemas/KnowledgeBasedAnswerSetEventNew"
  546. },
  547. {
  548. "$ref": "#/components/schemas/PersonalDetailsEventNew"
  549. },
  550. {
  551. "$ref": "#/components/schemas/SelfieEventNew"
  552. },
  553. {
  554. "$ref": "#/components/schemas/EnrichmentLexisNexisIdentityCheckEventNew"
  555. },
  556. {
  557. "$ref": "#/components/schemas/EnrichmentLexisNexisDeviceFingerprintEventNew"
  558. },
  559. {
  560. "$ref": "#/components/schemas/DeviceProfileEventNew"
  561. },
  562. {
  563. "$ref": "#/components/schemas/DeviceFingerprintEventNew"
  564. },
  565. {
  566. "$ref": "#/components/schemas/DeviceMotionEventNew"
  567. }
  568. ]
  569. },
  570. "EventFull": {
  571. "oneOf": [
  572. {
  573. "$ref": "#/components/schemas/IdentityDocumentEventFull"
  574. },
  575. {
  576. "$ref": "#/components/schemas/KnowledgeBasedAnswerSetEventFull"
  577. },
  578. {
  579. "$ref": "#/components/schemas/PersonalDetailsEventFull"
  580. },
  581. {
  582. "$ref": "#/components/schemas/SelfieEventFull"
  583. },
  584. {
  585. "$ref": "#/components/schemas/EnrichmentLexisNexisIdentityCheckEventFull"
  586. },
  587. {
  588. "$ref": "#/components/schemas/EnrichmentLexisNexisDeviceFingerprintEventFull"
  589. },
  590. {
  591. "$ref": "#/components/schemas/DeviceProfileEventFull"
  592. },
  593. {
  594. "$ref": "#/components/schemas/DeviceFingerprintEventFull"
  595. },
  596. {
  597. "$ref": "#/components/schemas/DeviceMotionEventFull"
  598. }
  599. ]
  600. },
  601. "IdentityDocumentEventNew": {
  602. "title": "Identity Document Event",
  603. "type": "object",
  604. "properties": {
  605. "type": {
  606. "type": "string",
  607. "description": "Type of Event",
  608. "enum": [
  609. "IDENTITY-DOCUMENT"
  610. ]
  611. },
  612. "reference": {
  613. "type": "string",
  614. "description": "A unique reference string used to link submitted events to a decision",
  615. "pattern": "^(.{1,100})$"
  616. },
  617. "occuredAt": {
  618. "type": "string",
  619. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  620. "format": "date-time"
  621. },
  622. "detail": {
  623. "type": "object",
  624. "description": "Information relating to the captured identification",
  625. "properties": {
  626. "type": {
  627. "type": "string",
  628. "enum": [
  629. "USDriversLicense"
  630. ]
  631. },
  632. "images": {
  633. "type": "array",
  634. "items": {
  635. "type": "string",
  636. "description": "Base64 encoded string representing an image of part of the identification"
  637. }
  638. },
  639. "data": {
  640. "type": "object",
  641. "description": "Data collected about the contents of the identification",
  642. "properties": {
  643. "firstName": {
  644. "type": "string"
  645. },
  646. "surname": {
  647. "type": "string"
  648. },
  649. "documentNo": {
  650. "type": "string"
  651. },
  652. "sex": {
  653. "type": "string"
  654. },
  655. "dateOfBirth": {
  656. "type": "string"
  657. },
  658. "dateOfExpiry": {
  659. "type": "string"
  660. },
  661. "dateOfIssue": {
  662. "type": "string"
  663. },
  664. "issuingAuthority": {
  665. "type": "string"
  666. },
  667. "address": {
  668. "type": "string"
  669. },
  670. "height": {
  671. "type": "string"
  672. },
  673. "country": {
  674. "type": "string"
  675. },
  676. "fullName": {
  677. "type": "string"
  678. },
  679. "18thBirthday": {
  680. "type": "string"
  681. },
  682. "19thBirthday": {
  683. "type": "string"
  684. },
  685. "21stBirthday": {
  686. "type": "string"
  687. }
  688. }
  689. }
  690. },
  691. "required": [
  692. "type",
  693. "images",
  694. "data"
  695. ]
  696. }
  697. },
  698. "required": [
  699. "type",
  700. "reference",
  701. "occuredAt",
  702. "detail"
  703. ],
  704. "example": {
  705. "type": "IDENTITY-DOCUMENT",
  706. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  707. "occuredAt": "2018-01-01T01:00:00Z",
  708. "detail": {
  709. "type": "USDriversLicense",
  710. "images": [
  711. "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOwAAACZCAYAAAAsPNZmQmCC...",
  712. "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANIAAAAzCAYAAADigVZlAAAQ..."
  713. ],
  714. "data": {
  715. "firstName": "BOB",
  716. "surname": "JONES",
  717. "documentNo": "D2446378",
  718. "sex": "2",
  719. "dateOfBirth": "01041976",
  720. "dateOfExpiry": "01042019",
  721. "dateOfIssue": "03292014",
  722. "issuingAuthority": "636014",
  723. "address": "123 5TH ST, OAKLAND, CA, 940680000",
  724. "height": "61 in",
  725. "country": "USA",
  726. "fullName": "BOB,LEE,JONES",
  727. "18thBirthday": "(null)",
  728. "19thBirthday": "(null)",
  729. "21stBirthday": "(null)"
  730. }
  731. }
  732. }
  733. },
  734. "KnowledgeBasedAnswerSetEventNew": {
  735. "title": "Knowledge Based Answers Event",
  736. "type": "object",
  737. "properties": {
  738. "type": {
  739. "type": "string",
  740. "description": "Type of Event",
  741. "enum": [
  742. "KNOWLEDGE-BASED-ANSWERS"
  743. ]
  744. },
  745. "reference": {
  746. "type": "string",
  747. "description": "A unique reference string used to link submitted events to a decision",
  748. "pattern": "^(.{1,100})$"
  749. },
  750. "occuredAt": {
  751. "type": "string",
  752. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  753. "format": "date-time"
  754. },
  755. "detail": {
  756. "type": "object",
  757. "description": "Information relating to the selected answers",
  758. "properties": {
  759. "token": {
  760. "type": "string",
  761. "description": "The identifer for the question answer set",
  762. "pattern": "^(.{1,100})$"
  763. },
  764. "answers": {
  765. "type": "array",
  766. "description": "An array of objects containing the ID of the question and the selected answer text",
  767. "items": {
  768. "type": "object",
  769. "properties": {
  770. "id": {
  771. "type": "string",
  772. "description": "The ID of the question"
  773. },
  774. "answer": {
  775. "type": "string",
  776. "description": "The selected answer to the question"
  777. }
  778. },
  779. "required": [
  780. "id",
  781. "answer"
  782. ]
  783. }
  784. }
  785. },
  786. "required": [
  787. "token",
  788. "answers"
  789. ],
  790. "additionalProperties": false
  791. }
  792. },
  793. "required": [
  794. "type",
  795. "reference",
  796. "occuredAt",
  797. "detail"
  798. ],
  799. "additionalProperties": false,
  800. "example": {
  801. "type": "KNOWLEDGE-BASED-ANSWERS",
  802. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  803. "occuredAt": "2018-01-01T01:00:00Z",
  804. "detail": {
  805. "token": "1bauxkpczhdiyy3vqm15ais8ue12u7zw",
  806. "answers": [
  807. {
  808. "id": "company0",
  809. "answer": "WALLACE CO"
  810. },
  811. {
  812. "id": "zip51",
  813. "answer": 54807
  814. },
  815. {
  816. "id": "college2",
  817. "answer": "STANFORD UNIVERSITY"
  818. },
  819. {
  820. "id": "state3",
  821. "answer": "CALIFORNIA"
  822. }
  823. ]
  824. }
  825. }
  826. },
  827. "PersonalDetailsEventNew": {
  828. "title": "Personal Details Event",
  829. "type": "object",
  830. "properties": {
  831. "type": {
  832. "type": "string",
  833. "description": "Type of Event",
  834. "enum": [
  835. "PERSONAL-DETAILS"
  836. ]
  837. },
  838. "reference": {
  839. "type": "string",
  840. "description": "A unique reference string used to link submitted events to a decision",
  841. "pattern": "^(.{1,100})$"
  842. },
  843. "occuredAt": {
  844. "type": "string",
  845. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  846. "format": "date-time"
  847. },
  848. "detail": {
  849. "type": "object",
  850. "description": "Information relating to the captured personal details",
  851. "properties": {
  852. "data": {
  853. "type": "object",
  854. "description": "data collected about the contents of the personal details",
  855. "properties": {
  856. "firstName": {
  857. "type": "string"
  858. },
  859. "lastName": {
  860. "type": "string"
  861. },
  862. "addressLine1": {
  863. "type": "string"
  864. },
  865. "addressLine2": {
  866. "type": "string"
  867. },
  868. "city": {
  869. "type": "string"
  870. },
  871. "stateCode": {
  872. "type": "string"
  873. },
  874. "postCode": {
  875. "type": "string"
  876. },
  877. "countryCode": {
  878. "type": "string"
  879. },
  880. "email": {
  881. "type": "string"
  882. },
  883. "phoneNumber": {
  884. "type": "string"
  885. },
  886. "dateOfBirth": {
  887. "type": "string",
  888. "format": "date"
  889. },
  890. "ssn": {
  891. "type": "string",
  892. "description": "Last four digits of Social Security Number",
  893. "pattern": "^([0-9]{4})$"
  894. }
  895. }
  896. }
  897. },
  898. "required": [
  899. "data"
  900. ]
  901. }
  902. },
  903. "required": [
  904. "type",
  905. "reference",
  906. "occuredAt",
  907. "detail"
  908. ],
  909. "example": {
  910. "type": "PERSONAL-DETAILS",
  911. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  912. "occuredAt": "2018-01-01T01:00:00Z",
  913. "detail": {
  914. "data": {
  915. "firstName": "BOB",
  916. "lastName": "JONES",
  917. "addressLine1": "123 5TH ST",
  918. "city": "Oakland",
  919. "stateCode": "CA",
  920. "postCode": "94068",
  921. "countryCode": "US",
  922. "email": "bob@jones.com",
  923. "phoneNumber": "555-555-1234",
  924. "dateOfBirth": "1990-07-21",
  925. "ssn": "1234"
  926. }
  927. }
  928. }
  929. },
  930. "SelfieEventNew": {
  931. "title": "Selfie Event",
  932. "type": "object",
  933. "properties": {
  934. "type": {
  935. "type": "string",
  936. "description": "Type of Event",
  937. "enum": [
  938. "SELFIE"
  939. ]
  940. },
  941. "reference": {
  942. "type": "string",
  943. "description": "A unique reference string used to link submitted events to a decision",
  944. "pattern": "^(.{1,100})$"
  945. },
  946. "occuredAt": {
  947. "type": "string",
  948. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  949. "format": "date-time"
  950. },
  951. "detail": {
  952. "type": "object",
  953. "description": "Information relating to the captured selfie",
  954. "properties": {
  955. "image": {
  956. "type": "string",
  957. "description": "Base64 encoded string representing selfie"
  958. },
  959. "exifData": {
  960. "type": "object",
  961. "description": "Exif data collected about the image"
  962. }
  963. },
  964. "required": [
  965. "image"
  966. ]
  967. }
  968. },
  969. "required": [
  970. "type",
  971. "reference",
  972. "occuredAt",
  973. "detail"
  974. ],
  975. "example": {
  976. "type": "SELFIE",
  977. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  978. "occuredAt": "2018-01-01T01:00:00Z",
  979. "detail": {
  980. "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANIAAAAzCAYAAADigVZlAAAQ...",
  981. "exifData": {
  982. "colourModel": "RGB",
  983. "dpiHeight": 72,
  984. "dpiWidth": 72,
  985. "depth": 8,
  986. "orientation": 6,
  987. "pixelHeight": 1936,
  988. "pixelWidth": 2592
  989. }
  990. }
  991. }
  992. },
  993. "EnrichmentLexisNexisIdentityCheckEventNew": {
  994. "title": "Enrichment Event Lexis Nexis Identity Check",
  995. "type": "object",
  996. "properties": {
  997. "type": {
  998. "type": "string",
  999. "description": "Type of Event",
  1000. "enum": [
  1001. "ENRICHMENT"
  1002. ]
  1003. },
  1004. "reference": {
  1005. "type": "string",
  1006. "description": "A unique reference string used to link submitted events to a decision",
  1007. "pattern": "^(.{1,100})$"
  1008. },
  1009. "occuredAt": {
  1010. "type": "string",
  1011. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1012. "format": "date-time"
  1013. },
  1014. "detail": {
  1015. "type": "object",
  1016. "description": "Information relating to the provider and their response",
  1017. "properties": {
  1018. "provider": {
  1019. "type": "string",
  1020. "description": "Provider Name",
  1021. "enum": [
  1022. "LEXIS-NEXIS"
  1023. ]
  1024. },
  1025. "product": {
  1026. "type": "string",
  1027. "description": "Actual product used",
  1028. "enum": [
  1029. "IDENTITY-CHECK"
  1030. ]
  1031. },
  1032. "response": {
  1033. "type": "object",
  1034. "description": "JSON representation of provider response"
  1035. }
  1036. },
  1037. "required": [
  1038. "provider",
  1039. "product",
  1040. "response"
  1041. ]
  1042. }
  1043. },
  1044. "required": [
  1045. "type",
  1046. "reference",
  1047. "occuredAt",
  1048. "detail"
  1049. ],
  1050. "example": {
  1051. "type": "ENRICHMENT",
  1052. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1053. "occuredAt": "2018-01-01T01:00:00Z",
  1054. "detail": {
  1055. "provider": "LEXIS-NEXIS",
  1056. "product": "IDENTITY-CHECK",
  1057. "response": {
  1058. "Status": {
  1059. "ConversationId": 987654321456789,
  1060. "RequestId": 123456789,
  1061. "TransactionStatus": "failed",
  1062. "TransactionReasonCode": {
  1063. "Code": "phone_finder_fail",
  1064. "Description": "Phone Finder Fail"
  1065. }
  1066. },
  1067. "Reference": "b85e3823"
  1068. }
  1069. }
  1070. }
  1071. },
  1072. "EnrichmentLexisNexisDeviceFingerprintEventNew": {
  1073. "title": "Enrichment Event Lexis Nexis Device Fingerprint",
  1074. "type": "object",
  1075. "properties": {
  1076. "type": {
  1077. "type": "string",
  1078. "description": "Type of Event",
  1079. "enum": [
  1080. "ENRICHMENT"
  1081. ]
  1082. },
  1083. "reference": {
  1084. "type": "string",
  1085. "description": "A unique reference string used to link submitted events to a decision",
  1086. "pattern": "^(.{1,100})$"
  1087. },
  1088. "occuredAt": {
  1089. "type": "string",
  1090. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1091. "format": "date-time"
  1092. },
  1093. "detail": {
  1094. "type": "object",
  1095. "description": "Information relating to the provider and their response",
  1096. "properties": {
  1097. "provider": {
  1098. "type": "string",
  1099. "description": "Provider Name",
  1100. "enum": [
  1101. "LEXIS-NEXIS"
  1102. ]
  1103. },
  1104. "product": {
  1105. "type": "string",
  1106. "description": "Actual product used",
  1107. "enum": [
  1108. "DEVICE-FINGERPRINT"
  1109. ]
  1110. },
  1111. "response": {
  1112. "type": "object",
  1113. "description": "JSON representation of provider response"
  1114. }
  1115. },
  1116. "required": [
  1117. "provider",
  1118. "product",
  1119. "response"
  1120. ]
  1121. }
  1122. },
  1123. "required": [
  1124. "type",
  1125. "reference",
  1126. "occuredAt",
  1127. "detail"
  1128. ],
  1129. "example": {
  1130. "type": "ENRICHMENT",
  1131. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1132. "occuredAt": "2018-01-01T01:00:00Z",
  1133. "detail": {
  1134. "provider": "LEXIS-NEXIS",
  1135. "product": "DEVICE-FINGERPRINT",
  1136. "response": {
  1137. "Status": {
  1138. "RequestId": "381652147",
  1139. "ConversationId": "31000156871254",
  1140. "TransactionStatus": "passed",
  1141. "TransactionReasonCode": {
  1142. "Code": "device_assessment_pass",
  1143. "Description": "DEVICE ASSESSMENT PASS"
  1144. }
  1145. },
  1146. "Products": [
  1147. {
  1148. "ProductType": "DeviceAssessment",
  1149. "ProductStatus": "pass",
  1150. "ExecutedStepName": "Device_Step",
  1151. "ProductConfigurationName": "some_device"
  1152. },
  1153. {
  1154. "ProductType": "DeviceAssessment",
  1155. "ProductReason": {
  1156. "Code": "device_assessment_pass",
  1157. "Description": "DEVICE ASSESSMENT PASS"
  1158. },
  1159. "ProductStatus": "pass",
  1160. "ExecutedStepName": "Decision",
  1161. "ProductConfigurationName": "DEVICE_ASSESSMENT_PASS"
  1162. }
  1163. ],
  1164. "PassThroughs": [
  1165. {
  1166. "Data": "{\"TrustDefenderResponseEx\":{\"response\": {}}",
  1167. "Type": "device.assessment"
  1168. }
  1169. ]
  1170. }
  1171. }
  1172. }
  1173. },
  1174. "DeviceProfileEventNew": {
  1175. "title": "Device Profile Event",
  1176. "type": "object",
  1177. "properties": {
  1178. "type": {
  1179. "type": "string",
  1180. "description": "Type of Event",
  1181. "enum": [
  1182. "DEVICE-PROFILE"
  1183. ]
  1184. },
  1185. "reference": {
  1186. "type": "string",
  1187. "description": "A unique reference string used to link submitted events to a decision",
  1188. "pattern": "^(.{1,100})$"
  1189. },
  1190. "occuredAt": {
  1191. "type": "string",
  1192. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1193. "format": "date-time"
  1194. },
  1195. "detail": {
  1196. "type": "object",
  1197. "description": "Information relating device profile",
  1198. "properties": {
  1199. "profiles": {
  1200. "type": "array",
  1201. "description": "An array of one or more device profiles",
  1202. "items": {
  1203. "anyOf": [
  1204. {
  1205. "title": "InAuth",
  1206. "type": "object",
  1207. "properties": {
  1208. "provider": {
  1209. "type": "string",
  1210. "enum": [
  1211. "INAUTH"
  1212. ],
  1213. "description": "Name of provider that captured device profile information"
  1214. },
  1215. "transactionId": {
  1216. "type": "string",
  1217. "description": "ID used to identity the inauth event",
  1218. "format": "uuid"
  1219. }
  1220. },
  1221. "required": [
  1222. "provider",
  1223. "transactionId"
  1224. ],
  1225. "example": {
  1226. "provider": "INAUTH",
  1227. "transactionId": "7c4fd0f3-7066-4c25-8871-3711781f3f25"
  1228. }
  1229. },
  1230. {
  1231. "title": "ThreatMetrix",
  1232. "type": "object",
  1233. "properties": {
  1234. "provider": {
  1235. "type": "string",
  1236. "enum": [
  1237. "THREATMETRIX"
  1238. ],
  1239. "description": "Name of provider that captured device profile information"
  1240. },
  1241. "sessionId": {
  1242. "type": "string",
  1243. "description": "ID used to identity the inauth event"
  1244. }
  1245. },
  1246. "required": [
  1247. "provider",
  1248. "sessionId"
  1249. ],
  1250. "example": {
  1251. "provider": "THREATMETRIX",
  1252. "sessionId": "7c4fd0f3-7066-4c25-8871-3711781f3f25"
  1253. }
  1254. }
  1255. ]
  1256. }
  1257. }
  1258. },
  1259. "required": [
  1260. "profiles"
  1261. ]
  1262. }
  1263. },
  1264. "required": [
  1265. "type",
  1266. "reference",
  1267. "occuredAt",
  1268. "detail"
  1269. ],
  1270. "example": {
  1271. "type": "DEVICE-PROFILE",
  1272. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1273. "occuredAt": "2018-01-01T01:00:00Z",
  1274. "detail": {
  1275. "profiles": [
  1276. {
  1277. "provider": "INAUTH",
  1278. "transactionId": "7066d0f3-23423-3fd3-sde3f-3wesdfsdf"
  1279. },
  1280. {
  1281. "provider": "THREATMETRIX",
  1282. "sessionId": "9348-3t435-3d343-2344-23sdfh23"
  1283. }
  1284. ]
  1285. }
  1286. }
  1287. },
  1288. "DeviceFingerprintEventNew": {
  1289. "title": "Device Fingerprint Event",
  1290. "type": "object",
  1291. "properties": {
  1292. "type": {
  1293. "type": "string",
  1294. "description": "Type of Event",
  1295. "enum": [
  1296. "DEVICE-FINGERPRINT"
  1297. ]
  1298. },
  1299. "reference": {
  1300. "type": "string",
  1301. "description": "A unique reference string used to link submitted events to a decision",
  1302. "pattern": "^(.{1,100})$"
  1303. },
  1304. "occuredAt": {
  1305. "type": "string",
  1306. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1307. "format": "date-time"
  1308. },
  1309. "detail": {
  1310. "type": "object",
  1311. "description": "Information Deep Labs have gathered from a device",
  1312. "properties": {
  1313. "fingerprint": {
  1314. "type": "object",
  1315. "description": "Deep Labs captured device data"
  1316. }
  1317. },
  1318. "required": [
  1319. "fingerprint"
  1320. ]
  1321. }
  1322. },
  1323. "required": [
  1324. "type",
  1325. "reference",
  1326. "occuredAt",
  1327. "detail"
  1328. ],
  1329. "example": {
  1330. "type": "DEVICE-FINGERPRINT",
  1331. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1332. "occuredAt": "2018-01-01T01:00:00Z",
  1333. "detail": {
  1334. "fingerprint": {
  1335. "deviceName": "my iPhone"
  1336. }
  1337. }
  1338. }
  1339. },
  1340. "DeviceMotionEventNew": {
  1341. "title": "Device Motion Event",
  1342. "type": "object",
  1343. "properties": {
  1344. "type": {
  1345. "type": "string",
  1346. "description": "Type of Event",
  1347. "enum": [
  1348. "DEVICE-MOTION"
  1349. ]
  1350. },
  1351. "reference": {
  1352. "type": "string",
  1353. "description": "A unique reference string used to link submitted events to a decision",
  1354. "pattern": "^(.{1,100})$"
  1355. },
  1356. "occuredAt": {
  1357. "type": "string",
  1358. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1359. "format": "date-time"
  1360. },
  1361. "detail": {
  1362. "type": "object",
  1363. "description": "Information Deep Labs have gathered from a device",
  1364. "properties": {
  1365. "motionData": {
  1366. "type": "object",
  1367. "description": "Deep Labs captured device motion data"
  1368. }
  1369. },
  1370. "required": [
  1371. "motionData"
  1372. ]
  1373. }
  1374. },
  1375. "required": [
  1376. "type",
  1377. "reference",
  1378. "occuredAt",
  1379. "detail"
  1380. ],
  1381. "example": {
  1382. "type": "DEVICE-MOTION",
  1383. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1384. "occuredAt": "2018-01-01T01:00:00Z",
  1385. "detail": {
  1386. "motionData": {
  1387. "chunk": 0
  1388. }
  1389. }
  1390. }
  1391. },
  1392. "IdentityDocumentEventFull": {
  1393. "title": "Identity Document Event",
  1394. "type": "object",
  1395. "properties": {
  1396. "id": {
  1397. "description": "ID of the created Event",
  1398. "type": "string",
  1399. "format": "uuid"
  1400. },
  1401. "clientId": {
  1402. "description": "UUID of the client credentials (subject) that made the request",
  1403. "type": "string",
  1404. "format": "uuid",
  1405. "readOnly": true
  1406. },
  1407. "accountId": {
  1408. "description": "UUID of the Account that owns the Event",
  1409. "type": "string",
  1410. "format": "uuid",
  1411. "readOnly": true
  1412. },
  1413. "createdAt": {
  1414. "type": "string",
  1415. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1416. "format": "date-time",
  1417. "readOnly": true
  1418. },
  1419. "type": {
  1420. "type": "string",
  1421. "description": "Type of Event",
  1422. "enum": [
  1423. "IDENTITY-DOCUMENT"
  1424. ]
  1425. },
  1426. "reference": {
  1427. "type": "string",
  1428. "description": "A unique reference string used to link submitted events to a decision",
  1429. "pattern": "^(.{1,100})$"
  1430. },
  1431. "occuredAt": {
  1432. "type": "string",
  1433. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1434. "format": "date-time"
  1435. },
  1436. "detail": {
  1437. "type": "object",
  1438. "description": "Information relating to the captured identification",
  1439. "properties": {
  1440. "type": {
  1441. "type": "string",
  1442. "enum": [
  1443. "USDriversLicense"
  1444. ]
  1445. },
  1446. "images": {
  1447. "type": "array",
  1448. "items": {
  1449. "type": "string",
  1450. "description": "Base64 encoded string representing an image of part of the identification"
  1451. }
  1452. },
  1453. "data": {
  1454. "type": "object",
  1455. "description": "Data collected about the contents of the identification",
  1456. "properties": {
  1457. "firstName": {
  1458. "type": "string"
  1459. },
  1460. "surname": {
  1461. "type": "string"
  1462. },
  1463. "documentNo": {
  1464. "type": "string"
  1465. },
  1466. "sex": {
  1467. "type": "string"
  1468. },
  1469. "dateOfBirth": {
  1470. "type": "string"
  1471. },
  1472. "dateOfExpiry": {
  1473. "type": "string"
  1474. },
  1475. "dateOfIssue": {
  1476. "type": "string"
  1477. },
  1478. "issuingAuthority": {
  1479. "type": "string"
  1480. },
  1481. "address": {
  1482. "type": "string"
  1483. },
  1484. "height": {
  1485. "type": "string"
  1486. },
  1487. "country": {
  1488. "type": "string"
  1489. },
  1490. "fullName": {
  1491. "type": "string"
  1492. },
  1493. "18thBirthday": {
  1494. "type": "string"
  1495. },
  1496. "19thBirthday": {
  1497. "type": "string"
  1498. },
  1499. "21stBirthday": {
  1500. "type": "string"
  1501. }
  1502. }
  1503. }
  1504. },
  1505. "required": [
  1506. "type",
  1507. "images",
  1508. "data"
  1509. ]
  1510. }
  1511. },
  1512. "required": [
  1513. "id",
  1514. "clientId",
  1515. "accountId",
  1516. "type",
  1517. "reference",
  1518. "createdAt",
  1519. "occuredAt",
  1520. "detail"
  1521. ],
  1522. "example": {
  1523. "id": "3e4282eb-7b79-4506-b5ee-d8818e6cb73a",
  1524. "clientId": "7bd0953d-0546-4cf7-a38e-ada8338621a7",
  1525. "accountId": "27ca2c10-ea70-4c62-94a0-0f303128ff3f",
  1526. "createdAt": "2019-01-30T10:00:00.000Z",
  1527. "type": "IDENTITY-DOCUMENT",
  1528. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1529. "occuredAt": "2018-01-01T01:00:00Z",
  1530. "detail": {
  1531. "type": "USDriversLicense",
  1532. "images": [
  1533. "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOwAAACZCAYAAAAsPNZmQmCC...",
  1534. "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANIAAAAzCAYAAADigVZlAAAQ..."
  1535. ],
  1536. "data": {
  1537. "firstName": "BOB",
  1538. "surname": "JONES",
  1539. "documentNo": "D2446378",
  1540. "sex": "2",
  1541. "dateOfBirth": "01041976",
  1542. "dateOfExpiry": "01042019",
  1543. "dateOfIssue": "03292014",
  1544. "issuingAuthority": "636014",
  1545. "address": "123 5TH ST, OAKLAND, CA, 940680000",
  1546. "height": "61 in",
  1547. "country": "USA",
  1548. "fullName": "BOB,LEE,JONES",
  1549. "18thBirthday": "(null)",
  1550. "19thBirthday": "(null)",
  1551. "21stBirthday": "(null)"
  1552. }
  1553. }
  1554. }
  1555. },
  1556. "KnowledgeBasedAnswerSetEventFull": {
  1557. "title": "Knowledge Based Answers Event",
  1558. "type": "object",
  1559. "properties": {
  1560. "id": {
  1561. "description": "ID of the created Event",
  1562. "type": "string",
  1563. "format": "uuid"
  1564. },
  1565. "clientId": {
  1566. "description": "UUID of the client credentials (subject) that made the request",
  1567. "type": "string",
  1568. "format": "uuid",
  1569. "readOnly": true
  1570. },
  1571. "accountId": {
  1572. "description": "UUID of the Account that owns the Event",
  1573. "type": "string",
  1574. "format": "uuid",
  1575. "readOnly": true
  1576. },
  1577. "createdAt": {
  1578. "type": "string",
  1579. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1580. "format": "date-time",
  1581. "readOnly": true
  1582. },
  1583. "type": {
  1584. "type": "string",
  1585. "description": "Type of Event",
  1586. "enum": [
  1587. "KNOWLEDGE-BASED-ANSWERS"
  1588. ]
  1589. },
  1590. "reference": {
  1591. "type": "string",
  1592. "description": "A unique reference string used to link submitted events to a decision",
  1593. "pattern": "^(.{1,100})$"
  1594. },
  1595. "occuredAt": {
  1596. "type": "string",
  1597. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1598. "format": "date-time"
  1599. },
  1600. "detail": {
  1601. "type": "object",
  1602. "description": "Information relating to the selected answers",
  1603. "properties": {
  1604. "token": {
  1605. "type": "string",
  1606. "description": "The identifer for the question answer set",
  1607. "pattern": "^(.{1,100})$"
  1608. },
  1609. "answers": {
  1610. "type": "array",
  1611. "description": "An array of objects containing the ID of the question and the selected answer text",
  1612. "items": {
  1613. "type": "object",
  1614. "properties": {
  1615. "id": {
  1616. "type": "string",
  1617. "description": "The ID of the question"
  1618. },
  1619. "answer": {
  1620. "type": "string",
  1621. "description": "The selected answer to the question"
  1622. }
  1623. },
  1624. "required": [
  1625. "id",
  1626. "answer"
  1627. ]
  1628. }
  1629. }
  1630. },
  1631. "required": [
  1632. "token",
  1633. "answers"
  1634. ]
  1635. }
  1636. },
  1637. "required": [
  1638. "id",
  1639. "clientId",
  1640. "accountId",
  1641. "type",
  1642. "reference",
  1643. "createdAt",
  1644. "occuredAt",
  1645. "detail"
  1646. ],
  1647. "example": {
  1648. "id": "39bd85a9-bec9-45a0-8139-814602c9bf10",
  1649. "clientId": "7bd0953d-0546-4cf7-a38e-ada8338621a7",
  1650. "accountId": "27ca2c10-ea70-4c62-94a0-0f303128ff3f",
  1651. "type": "KNOWLEDGE-BASED-ANSWERS",
  1652. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1653. "createdAt": "2019-01-01T01:00:05Z",
  1654. "occuredAt": "2019-01-01T01:00:00Z",
  1655. "detail": {
  1656. "token": "1bauxkpczhdiyy3vqm15ais8ue12u7zw",
  1657. "answers": [
  1658. {
  1659. "id": "company0",
  1660. "answer": "WALLACE CO"
  1661. },
  1662. {
  1663. "id": "zip51",
  1664. "answer": 54807
  1665. },
  1666. {
  1667. "id": "college2",
  1668. "answer": "STANFORD UNIVERSITY"
  1669. },
  1670. {
  1671. "id": "state3",
  1672. "answer": "CALIFORNIA"
  1673. }
  1674. ]
  1675. }
  1676. }
  1677. },
  1678. "PersonalDetailsEventFull": {
  1679. "title": "Personal Details Event",
  1680. "type": "object",
  1681. "properties": {
  1682. "id": {
  1683. "description": "ID of the created Event",
  1684. "type": "string",
  1685. "format": "uuid"
  1686. },
  1687. "clientId": {
  1688. "description": "UUID of the client credentials (subject) that made the request",
  1689. "type": "string",
  1690. "format": "uuid",
  1691. "readOnly": true
  1692. },
  1693. "accountId": {
  1694. "description": "UUID of the Account that owns the Event",
  1695. "type": "string",
  1696. "format": "uuid",
  1697. "readOnly": true
  1698. },
  1699. "createdAt": {
  1700. "type": "string",
  1701. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1702. "format": "date-time",
  1703. "readOnly": true
  1704. },
  1705. "type": {
  1706. "type": "string",
  1707. "description": "Type of Event",
  1708. "enum": [
  1709. "PERSONAL-DETAILS"
  1710. ]
  1711. },
  1712. "reference": {
  1713. "type": "string",
  1714. "description": "A unique reference string used to link submitted events to a decision",
  1715. "pattern": "^(.{1,100})$"
  1716. },
  1717. "occuredAt": {
  1718. "type": "string",
  1719. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1720. "format": "date-time"
  1721. },
  1722. "detail": {
  1723. "type": "object",
  1724. "description": "Information relating to the captured personal details",
  1725. "properties": {
  1726. "data": {
  1727. "type": "object",
  1728. "description": "data collected about the contents of the personal details",
  1729. "properties": {
  1730. "firstName": {
  1731. "type": "string"
  1732. },
  1733. "lastName": {
  1734. "type": "string"
  1735. },
  1736. "addressLine1": {
  1737. "type": "string"
  1738. },
  1739. "addressLine2": {
  1740. "type": "string"
  1741. },
  1742. "city": {
  1743. "type": "string"
  1744. },
  1745. "stateCode": {
  1746. "type": "string"
  1747. },
  1748. "postCode": {
  1749. "type": "string"
  1750. },
  1751. "countryCode": {
  1752. "type": "string"
  1753. },
  1754. "email": {
  1755. "type": "string"
  1756. },
  1757. "phoneNumber": {
  1758. "type": "string"
  1759. },
  1760. "dateOfBirth": {
  1761. "type": "string",
  1762. "format": "date"
  1763. },
  1764. "ssn": {
  1765. "type": "string",
  1766. "description": "Last four digits of Social Security Number",
  1767. "pattern": "^([0-9]{4})$"
  1768. }
  1769. }
  1770. }
  1771. },
  1772. "required": [
  1773. "data"
  1774. ]
  1775. }
  1776. },
  1777. "required": [
  1778. "id",
  1779. "clientId",
  1780. "accountId",
  1781. "type",
  1782. "reference",
  1783. "createdAt",
  1784. "occuredAt",
  1785. "detail"
  1786. ],
  1787. "example": {
  1788. "id": "3e4282eb-7b79-4506-b5ee-d8818e6cb73a",
  1789. "clientId": "7bd0953d-0546-4cf7-a38e-ada8338621a7",
  1790. "accountId": "27ca2c10-ea70-4c62-94a0-0f303128ff3f",
  1791. "createdAt": "2019-01-30T10:00:00.000Z",
  1792. "type": "PERSONAL-DETAILS",
  1793. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1794. "occuredAt": "2018-01-01T01:00:00Z",
  1795. "detail": {
  1796. "data": {
  1797. "firstName": "BOB",
  1798. "lastName": "JONES",
  1799. "addressLine1": "123 5TH ST",
  1800. "city": "Oakland",
  1801. "stateCode": "CA",
  1802. "postCode": "94068",
  1803. "countryCode": "US",
  1804. "email": "bob@jones.com",
  1805. "phoneNumber": "555-555-1234",
  1806. "dateOfBirth": "1990-07-21",
  1807. "ssn": "1234"
  1808. }
  1809. }
  1810. }
  1811. },
  1812. "SelfieEventFull": {
  1813. "title": "Selfie Event",
  1814. "type": "object",
  1815. "properties": {
  1816. "id": {
  1817. "description": "ID of the created Event",
  1818. "type": "string",
  1819. "format": "uuid"
  1820. },
  1821. "clientId": {
  1822. "description": "UUID of the client credentials (subject) that made the request",
  1823. "type": "string",
  1824. "format": "uuid",
  1825. "readOnly": true
  1826. },
  1827. "accountId": {
  1828. "description": "UUID of the Account that owns the Event",
  1829. "type": "string",
  1830. "format": "uuid",
  1831. "readOnly": true
  1832. },
  1833. "createdAt": {
  1834. "type": "string",
  1835. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1836. "format": "date-time",
  1837. "readOnly": true
  1838. },
  1839. "type": {
  1840. "type": "string",
  1841. "description": "Type of Event",
  1842. "enum": [
  1843. "SELFIE"
  1844. ]
  1845. },
  1846. "reference": {
  1847. "type": "string",
  1848. "description": "A unique reference string used to link submitted events to a decision",
  1849. "pattern": "^(.{1,100})$"
  1850. },
  1851. "occuredAt": {
  1852. "type": "string",
  1853. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1854. "format": "date-time"
  1855. },
  1856. "detail": {
  1857. "type": "object",
  1858. "description": "Information relating to the captured selfie",
  1859. "properties": {
  1860. "image": {
  1861. "type": "string",
  1862. "description": "Base64 encoded string representing selfie"
  1863. },
  1864. "exifData": {
  1865. "type": "object",
  1866. "description": "Exif data collected about the image"
  1867. }
  1868. },
  1869. "required": [
  1870. "image"
  1871. ]
  1872. }
  1873. },
  1874. "required": [
  1875. "id",
  1876. "clientId",
  1877. "accountId",
  1878. "type",
  1879. "reference",
  1880. "createdAt",
  1881. "occuredAt",
  1882. "detail"
  1883. ],
  1884. "example": {
  1885. "id": "3e4282eb-7b79-4506-b5ee-d8818e6cb73a",
  1886. "clientId": "7bd0953d-0546-4cf7-a38e-ada8338621a7",
  1887. "accountId": "27ca2c10-ea70-4c62-94a0-0f303128ff3f",
  1888. "createdAt": "2019-01-30T10:00:00.000Z",
  1889. "type": "SELFIE",
  1890. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1891. "occuredAt": "2018-01-01T01:00:00Z",
  1892. "detail": {
  1893. "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANIAAAAzCAYAAADigVZlAAAQ...",
  1894. "exifData": {
  1895. "colourModel": "RGB",
  1896. "dpiHeight": 72,
  1897. "dpiWidth": 72,
  1898. "depth": 8,
  1899. "orientation": 6,
  1900. "pixelHeight": 1936,
  1901. "pixelWidth": 2592
  1902. }
  1903. }
  1904. }
  1905. },
  1906. "EnrichmentLexisNexisIdentityCheckEventFull": {
  1907. "title": "Enrichment Event Lexis Nexis Identity Check",
  1908. "type": "object",
  1909. "properties": {
  1910. "id": {
  1911. "description": "ID of the created Event",
  1912. "type": "string",
  1913. "format": "uuid"
  1914. },
  1915. "clientId": {
  1916. "description": "UUID of the client credentials (subject) that made the request",
  1917. "type": "string",
  1918. "format": "uuid",
  1919. "readOnly": true
  1920. },
  1921. "accountId": {
  1922. "description": "UUID of the Account that owns the Event",
  1923. "type": "string",
  1924. "format": "uuid",
  1925. "readOnly": true
  1926. },
  1927. "createdAt": {
  1928. "type": "string",
  1929. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1930. "format": "date-time",
  1931. "readOnly": true
  1932. },
  1933. "type": {
  1934. "type": "string",
  1935. "description": "Type of Event",
  1936. "enum": [
  1937. "ENRICHMENT"
  1938. ]
  1939. },
  1940. "reference": {
  1941. "type": "string",
  1942. "description": "A unique reference string used to link submitted events to a decision",
  1943. "pattern": "^(.{1,100})$"
  1944. },
  1945. "occuredAt": {
  1946. "type": "string",
  1947. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  1948. "format": "date-time"
  1949. },
  1950. "detail": {
  1951. "type": "object",
  1952. "description": "Information relating to the provider and their response",
  1953. "properties": {
  1954. "provider": {
  1955. "type": "string",
  1956. "description": "Provider Name",
  1957. "enum": [
  1958. "LEXIS-NEXIS"
  1959. ]
  1960. },
  1961. "product": {
  1962. "type": "string",
  1963. "description": "Actual product used",
  1964. "enum": [
  1965. "IDENTITY-CHECK"
  1966. ]
  1967. },
  1968. "response": {
  1969. "type": "object",
  1970. "description": "JSON representation of provider response"
  1971. }
  1972. },
  1973. "required": [
  1974. "provider",
  1975. "product",
  1976. "response"
  1977. ]
  1978. }
  1979. },
  1980. "required": [
  1981. "id",
  1982. "clientId",
  1983. "accountId",
  1984. "type",
  1985. "reference",
  1986. "createdAt",
  1987. "occuredAt",
  1988. "detail"
  1989. ],
  1990. "example": {
  1991. "id": "3e4282eb-7b79-4506-b5ee-d8818e6cb73a",
  1992. "clientId": "7bd0953d-0546-4cf7-a38e-ada8338621a7",
  1993. "accountId": "27ca2c10-ea70-4c62-94a0-0f303128ff3f",
  1994. "createdAt": "2019-01-30T10:00:00.000Z",
  1995. "type": "ENRICHMENT",
  1996. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  1997. "occuredAt": "2018-01-01T01:00:00Z",
  1998. "detail": {
  1999. "provider": "LEXIS-NEXIS",
  2000. "product": "IDENTITY-CHECK",
  2001. "response": {
  2002. "Status": {
  2003. "ConversationId": 987654321456789,
  2004. "RequestId": 123456789,
  2005. "TransactionStatus": "failed",
  2006. "TransactionReasonCode": {
  2007. "Code": "phone_finder_fail",
  2008. "Description": "Phone Finder Fail"
  2009. }
  2010. },
  2011. "Reference": "b85e3823"
  2012. }
  2013. }
  2014. }
  2015. },
  2016. "EnrichmentLexisNexisDeviceFingerprintEventFull": {
  2017. "title": "Enrichment Event Lexis Nexis Device Fingerprint",
  2018. "type": "object",
  2019. "properties": {
  2020. "id": {
  2021. "description": "ID of the created Event",
  2022. "type": "string",
  2023. "format": "uuid"
  2024. },
  2025. "clientId": {
  2026. "description": "UUID of the client credentials (subject) that made the request",
  2027. "type": "string",
  2028. "format": "uuid",
  2029. "readOnly": true
  2030. },
  2031. "accountId": {
  2032. "description": "UUID of the Account that owns the Event",
  2033. "type": "string",
  2034. "format": "uuid",
  2035. "readOnly": true
  2036. },
  2037. "createdAt": {
  2038. "type": "string",
  2039. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  2040. "format": "date-time",
  2041. "readOnly": true
  2042. },
  2043. "type": {
  2044. "type": "string",
  2045. "description": "Type of Event",
  2046. "enum": [
  2047. "ENRICHMENT"
  2048. ]
  2049. },
  2050. "reference": {
  2051. "type": "string",
  2052. "description": "A unique reference string used to link submitted events to a decision",
  2053. "pattern": "^(.{1,100})$"
  2054. },
  2055. "occuredAt": {
  2056. "type": "string",
  2057. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  2058. "format": "date-time"
  2059. },
  2060. "detail": {
  2061. "type": "object",
  2062. "description": "Information relating to the provider and their response",
  2063. "properties": {
  2064. "provider": {
  2065. "type": "string",
  2066. "description": "Provider Name",
  2067. "enum": [
  2068. "LEXIS-NEXIS"
  2069. ]
  2070. },
  2071. "product": {
  2072. "type": "string",
  2073. "description": "Actual product used",
  2074. "enum": [
  2075. "DEVICE-FINGERPRINT"
  2076. ]
  2077. },
  2078. "response": {
  2079. "type": "object",
  2080. "description": "JSON representation of provider response"
  2081. }
  2082. },
  2083. "required": [
  2084. "provider",
  2085. "product",
  2086. "response"
  2087. ]
  2088. }
  2089. },
  2090. "required": [
  2091. "id",
  2092. "clientId",
  2093. "accountId",
  2094. "type",
  2095. "reference",
  2096. "createdAt",
  2097. "occuredAt",
  2098. "detail"
  2099. ],
  2100. "example": {
  2101. "id": "3e4282eb-7b79-4506-b5ee-d8818e6cb73a",
  2102. "clientId": "7bd0953d-0546-4cf7-a38e-ada8338621a7",
  2103. "accountId": "27ca2c10-ea70-4c62-94a0-0f303128ff3f",
  2104. "createdAt": "2019-01-30T10:00:00.000Z",
  2105. "type": "ENRICHMENT",
  2106. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  2107. "occuredAt": "2018-01-01T01:00:00Z",
  2108. "detail": {
  2109. "provider": "LEXIS-NEXIS",
  2110. "product": "DEVICE-FINGERPRINT",
  2111. "response": {
  2112. "Status": {
  2113. "RequestId": "381652147",
  2114. "ConversationId": "31000156871254",
  2115. "TransactionStatus": "passed",
  2116. "TransactionReasonCode": {
  2117. "Code": "device_assessment_pass",
  2118. "Description": "DEVICE ASSESSMENT PASS"
  2119. }
  2120. },
  2121. "Products": [
  2122. {
  2123. "ProductType": "DeviceAssessment",
  2124. "ProductStatus": "pass",
  2125. "ExecutedStepName": "Device_Step",
  2126. "ProductConfigurationName": "some_device"
  2127. },
  2128. {
  2129. "ProductType": "DeviceAssessment",
  2130. "ProductReason": {
  2131. "Code": "device_assessment_pass",
  2132. "Description": "DEVICE ASSESSMENT PASS"
  2133. },
  2134. "ProductStatus": "pass",
  2135. "ExecutedStepName": "Decision",
  2136. "ProductConfigurationName": "DEVICE_ASSESSMENT_PASS"
  2137. }
  2138. ],
  2139. "PassThroughs": [
  2140. {
  2141. "Data": "{\"TrustDefenderResponseEx\":{\"response\": {}}",
  2142. "Type": "device.assessment"
  2143. }
  2144. ]
  2145. }
  2146. }
  2147. }
  2148. },
  2149. "DeviceProfileEventFull": {
  2150. "title": "Device Profile Event",
  2151. "type": "object",
  2152. "properties": {
  2153. "id": {
  2154. "description": "ID of the created Event",
  2155. "type": "string",
  2156. "format": "uuid"
  2157. },
  2158. "clientId": {
  2159. "description": "UUID of the client credentials (subject) that made the request",
  2160. "type": "string",
  2161. "format": "uuid",
  2162. "readOnly": true
  2163. },
  2164. "accountId": {
  2165. "description": "UUID of the Account that owns the Event",
  2166. "type": "string",
  2167. "format": "uuid",
  2168. "readOnly": true
  2169. },
  2170. "createdAt": {
  2171. "type": "string",
  2172. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  2173. "format": "date-time",
  2174. "readOnly": true
  2175. },
  2176. "type": {
  2177. "type": "string",
  2178. "description": "Type of Event",
  2179. "enum": [
  2180. "DEVICE-PROFILE"
  2181. ]
  2182. },
  2183. "reference": {
  2184. "type": "string",
  2185. "description": "A unique reference string used to link submitted events to a decision",
  2186. "pattern": "^(.{1,100})$"
  2187. },
  2188. "occuredAt": {
  2189. "type": "string",
  2190. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  2191. "format": "date-time"
  2192. },
  2193. "detail": {
  2194. "type": "object",
  2195. "description": "Information relating device profile",
  2196. "properties": {
  2197. "profiles": {
  2198. "type": "array",
  2199. "description": "An array of one or more device profiles",
  2200. "items": {
  2201. "anyOf": [
  2202. {
  2203. "$ref": "#/components/schemas/DeviceProfileEventNew/properties/detail/properties/profiles/items/anyOf/0"
  2204. },
  2205. {
  2206. "$ref": "#/components/schemas/DeviceProfileEventNew/properties/detail/properties/profiles/items/anyOf/1"
  2207. }
  2208. ]
  2209. }
  2210. }
  2211. },
  2212. "required": [
  2213. "profiles"
  2214. ]
  2215. }
  2216. },
  2217. "required": [
  2218. "id",
  2219. "clientId",
  2220. "accountId",
  2221. "type",
  2222. "reference",
  2223. "createdAt",
  2224. "occuredAt",
  2225. "detail"
  2226. ],
  2227. "example": {
  2228. "id": "3e4282eb-7b79-4506-b5ee-d8818e6cb73a",
  2229. "clientId": "7bd0953d-0546-4cf7-a38e-ada8338621a7",
  2230. "accountId": "27ca2c10-ea70-4c62-94a0-0f303128ff3f",
  2231. "createdAt": "2019-01-30T10:00:00.000Z",
  2232. "type": "DEVICE-PROFILE",
  2233. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  2234. "detail": {
  2235. "profiles": [
  2236. {
  2237. "provider": "INAUTH",
  2238. "transactionId": "7066d0f3-23423-3fd3-sde3f-3wesdfsdf"
  2239. },
  2240. {
  2241. "provider": "THREATMETRIX",
  2242. "sessionId": "9348-3t435-3d343-2344-23sdfh23"
  2243. }
  2244. ]
  2245. }
  2246. }
  2247. },
  2248. "DeviceFingerprintEventFull": {
  2249. "title": "Device Fingerprint Event",
  2250. "type": "object",
  2251. "properties": {
  2252. "id": {
  2253. "description": "ID of the created Event",
  2254. "type": "string",
  2255. "format": "uuid"
  2256. },
  2257. "clientId": {
  2258. "description": "UUID of the client credentials (subject) that made the request",
  2259. "type": "string",
  2260. "format": "uuid",
  2261. "readOnly": true
  2262. },
  2263. "accountId": {
  2264. "description": "UUID of the Account that owns the Event",
  2265. "type": "string",
  2266. "format": "uuid",
  2267. "readOnly": true
  2268. },
  2269. "createdAt": {
  2270. "type": "string",
  2271. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  2272. "format": "date-time",
  2273. "readOnly": true
  2274. },
  2275. "type": {
  2276. "type": "string",
  2277. "description": "Type of Event",
  2278. "enum": [
  2279. "DEVICE-FINGERPRINT"
  2280. ]
  2281. },
  2282. "reference": {
  2283. "type": "string",
  2284. "description": "A unique reference string used to link submitted events to a decision",
  2285. "pattern": "^(.{1,100})$"
  2286. },
  2287. "occuredAt": {
  2288. "type": "string",
  2289. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  2290. "format": "date-time"
  2291. },
  2292. "detail": {
  2293. "type": "object",
  2294. "description": "Information Deep Labs have gathered from a device",
  2295. "properties": {
  2296. "fingerprint": {
  2297. "type": "object",
  2298. "description": "Deep Labs captured device data"
  2299. }
  2300. },
  2301. "required": [
  2302. "fingerprint"
  2303. ]
  2304. }
  2305. },
  2306. "required": [
  2307. "id",
  2308. "clientId",
  2309. "accountId",
  2310. "type",
  2311. "reference",
  2312. "createdAt",
  2313. "occuredAt",
  2314. "detail"
  2315. ],
  2316. "example": {
  2317. "id": "3e4282eb-7b79-4506-b5ee-d8818e6cb73a",
  2318. "clientId": "7bd0953d-0546-4cf7-a38e-ada8338621a7",
  2319. "accountId": "27ca2c10-ea70-4c62-94a0-0f303128ff3f",
  2320. "createdAt": "2019-01-30T10:00:00.000Z",
  2321. "type": "DEVICE-FINGERPRINT",
  2322. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  2323. "occuredAt": "2018-01-01T01:00:00Z",
  2324. "detail": {
  2325. "fingerprint": {
  2326. "deviceName": "my iPhone"
  2327. }
  2328. }
  2329. }
  2330. },
  2331. "DeviceMotionEventFull": {
  2332. "title": "Device Motion Event",
  2333. "type": "object",
  2334. "properties": {
  2335. "id": {
  2336. "description": "ID of the created Event",
  2337. "type": "string",
  2338. "format": "uuid"
  2339. },
  2340. "clientId": {
  2341. "description": "UUID of the client credentials (subject) that made the request",
  2342. "type": "string",
  2343. "format": "uuid",
  2344. "readOnly": true
  2345. },
  2346. "accountId": {
  2347. "description": "UUID of the Account that owns the Event",
  2348. "type": "string",
  2349. "format": "uuid",
  2350. "readOnly": true
  2351. },
  2352. "createdAt": {
  2353. "type": "string",
  2354. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  2355. "format": "date-time",
  2356. "readOnly": true
  2357. },
  2358. "type": {
  2359. "type": "string",
  2360. "description": "Type of Event",
  2361. "enum": [
  2362. "DEVICE-MOTION"
  2363. ]
  2364. },
  2365. "reference": {
  2366. "type": "string",
  2367. "description": "A unique reference string used to link submitted events to a decision",
  2368. "pattern": "^(.{1,100})$"
  2369. },
  2370. "occuredAt": {
  2371. "type": "string",
  2372. "description": "The date and time that this event occured at (ISO 8601 date-time)",
  2373. "format": "date-time"
  2374. },
  2375. "detail": {
  2376. "type": "object",
  2377. "description": "Information Deep Labs have gathered from a device",
  2378. "properties": {
  2379. "motionData": {
  2380. "type": "object",
  2381. "description": "Deep Labs captured device motion data"
  2382. }
  2383. },
  2384. "required": [
  2385. "motionData"
  2386. ]
  2387. }
  2388. },
  2389. "required": [
  2390. "id",
  2391. "clientId",
  2392. "accountId",
  2393. "type",
  2394. "reference",
  2395. "createdAt",
  2396. "occuredAt",
  2397. "detail"
  2398. ],
  2399. "example": {
  2400. "id": "3e4282eb-7b79-4506-b5ee-d8818e6cb73a",
  2401. "clientId": "7bd0953d-0546-4cf7-a38e-ada8338621a7",
  2402. "accountId": "27ca2c10-ea70-4c62-94a0-0f303128ff3f",
  2403. "createdAt": "2019-01-30T10:00:00.000Z",
  2404. "type": "DEVICE-MOTION",
  2405. "reference": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  2406. "occuredAt": "2018-01-01T01:00:00Z",
  2407. "detail": {
  2408. "motionData": {
  2409. "chunk": 0
  2410. }
  2411. }
  2412. }
  2413. },
  2414. "EventTypes": {
  2415. "type": "string",
  2416. "enum": [
  2417. "IDENTITY-DOCUMENT",
  2418. "KNOWLEDGE-BASED-ANSWERS",
  2419. "PERSONAL-DETAILS",
  2420. "SELFIE",
  2421. "ENRICHMENT"
  2422. ]
  2423. },
  2424. "Request": {
  2425. "type": "object",
  2426. "properties": {
  2427. "recipe": {
  2428. "description": "Name of the recipe to use for this decision",
  2429. "type": "string"
  2430. },
  2431. "reference": {
  2432. "description": "The unique UUID that will be used when submitting events to the events-api",
  2433. "type": "string",
  2434. "format": "uuid"
  2435. }
  2436. },
  2437. "required": [
  2438. "recipe",
  2439. "reference"
  2440. ],
  2441. "example": {
  2442. "recipe": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  2443. "reference": "aa4e2f7c-8de7-439b-8b20-85f357b6fea5"
  2444. }
  2445. },
  2446. "Decision": {
  2447. "type": "object",
  2448. "properties": {
  2449. "id": {
  2450. "description": "ID of the created decision",
  2451. "type": "string",
  2452. "format": "uuid",
  2453. "readOnly": true
  2454. },
  2455. "accountId": {
  2456. "description": "Unique ID of account that created this decision",
  2457. "type": "string",
  2458. "readOnly": true
  2459. },
  2460. "recipe": {
  2461. "description": "Human-readable name for the recipe used for this decision",
  2462. "type": "string"
  2463. },
  2464. "recipeId": {
  2465. "description": "ID of the recipe used for this decision",
  2466. "type": "string",
  2467. "format": "uuid"
  2468. },
  2469. "reference": {
  2470. "description": "The unique UUID that will be used when submitting events to the events-api",
  2471. "type": "string",
  2472. "format": "uuid"
  2473. },
  2474. "requiredEvents": {
  2475. "description": "The collection of events required to be submitted to the platform to complete this decision",
  2476. "type": "array",
  2477. "items": {
  2478. "type": "string"
  2479. },
  2480. "uniqueItems": true,
  2481. "readOnly": true
  2482. },
  2483. "receivedEvents": {
  2484. "description": "The collection of events already received by the platform in relation to this decision",
  2485. "type": "array",
  2486. "items": {
  2487. "type": "string"
  2488. },
  2489. "uniqueItems": true,
  2490. "readOnly": true
  2491. },
  2492. "createdAt": {
  2493. "description": "The date and time this decision was created in the platform (ISO 8601 date-time)",
  2494. "type": "string",
  2495. "format": "date-time",
  2496. "readOnly": true
  2497. },
  2498. "result": {
  2499. "description": "The result of the decision",
  2500. "oneOf": [
  2501. {
  2502. "type": "string"
  2503. },
  2504. {
  2505. "type": "integer"
  2506. }
  2507. ],
  2508. "readOnly": true
  2509. }
  2510. },
  2511. "required": [
  2512. "id",
  2513. "accountId",
  2514. "recipe",
  2515. "recipeId",
  2516. "reference",
  2517. "requiredEvents",
  2518. "receivedEvents",
  2519. "createdAt"
  2520. ],
  2521. "example": {
  2522. "id": "7c4fd0f3-7066-4c25-8871-3711781f3f25",
  2523. "recipe": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  2524. "reference": "aa4e2f7c-8de7-439b-8b20-85f357b6fea5",
  2525. "requiredEvents": [
  2526. "IDENTITY-DOCUMENTS",
  2527. "SELFIE"
  2528. ],
  2529. "receivedEvents": [
  2530. "DEVICE-PROFILE"
  2531. ],
  2532. "createdAt": "2018-01-01T01:00:00Z"
  2533. }
  2534. },
  2535. "Status": {
  2536. "type": "object",
  2537. "properties": {
  2538. "name": {
  2539. "description": "Name of the API",
  2540. "type": "string"
  2541. },
  2542. "status": {
  2543. "description": "The status of the API",
  2544. "type": "string",
  2545. "enum": [
  2546. "SUCCESS",
  2547. "WARNING",
  2548. "FATAL"
  2549. ]
  2550. },
  2551. "version": {
  2552. "description": "Version of the API being served",
  2553. "type": "string"
  2554. }
  2555. },
  2556. "required": [
  2557. "name",
  2558. "status",
  2559. "version"
  2560. ],
  2561. "example": {
  2562. "name": "Decisions API",
  2563. "status": "SUCCESS",
  2564. "version": "v2"
  2565. }
  2566. }
  2567. },
  2568. "responses": {
  2569. "BadRequest": {
  2570. "description": "The server cannot or will not process the request due to something that is perceived to be a client error",
  2571. "content": {
  2572. "application/json": {
  2573. "schema": {
  2574. "$ref": "#/components/schemas/Error"
  2575. },
  2576. "example": {
  2577. "status": 400,
  2578. "error": "Bad Request"
  2579. }
  2580. }
  2581. }
  2582. },
  2583. "Unauthorized": {
  2584. "description": "The request has not been applied because it lacks valid authentication credentials for the target resource.",
  2585. "content": {
  2586. "application/json": {
  2587. "schema": {
  2588. "$ref": "#/components/schemas/Error"
  2589. },
  2590. "example": {
  2591. "status": 401,
  2592. "error": "Unauthorized"
  2593. }
  2594. }
  2595. }
  2596. },
  2597. "NotFound": {
  2598. "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.",
  2599. "content": {
  2600. "application/json": {
  2601. "schema": {
  2602. "$ref": "#/components/schemas/Error"
  2603. },
  2604. "example": {
  2605. "status": 404,
  2606. "error": "Not found"
  2607. }
  2608. }
  2609. }
  2610. },
  2611. "Conflict": {
  2612. "description": "The request could not be completed due to a conflict with the current state of the target resource.",
  2613. "content": {
  2614. "application/json": {
  2615. "schema": {
  2616. "$ref": "#/components/schemas/Error"
  2617. },
  2618. "example": {
  2619. "status": 409,
  2620. "error": "Conflict"
  2621. }
  2622. }
  2623. }
  2624. },
  2625. "InternalServerError": {
  2626. "description": "The server encountered an unexpected condition which prevented it from fulfilling the request",
  2627. "content": {
  2628. "application/json": {
  2629. "schema": {
  2630. "$ref": "#/components/schemas/Error"
  2631. },
  2632. "example": {
  2633. "status": 500,
  2634. "error": "Internal Server Error"
  2635. }
  2636. }
  2637. }
  2638. },
  2639. "UnprocessibleEntity": {
  2640. "description": "The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.",
  2641. "content": {
  2642. "application/json": {
  2643. "schema": {
  2644. "$ref": "#/components/schemas/Error"
  2645. },
  2646. "example": {
  2647. "status": 422,
  2648. "error": "Invalid recipe"
  2649. }
  2650. }
  2651. }
  2652. }
  2653. },
  2654. "examples": {
  2655. "InProgressDecision": {
  2656. "summary": "An in progress Decision",
  2657. "value": {
  2658. "id": "7c4fd0f3-7066-4c25-8871-3711781f3f25",
  2659. "recipe": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  2660. "reference": "aa4e2f7c-8de7-439b-8b20-85f357b6fea5",
  2661. "requiredEvents": [
  2662. "IDENTITY-DOCUMENTS",
  2663. "SELFIE"
  2664. ],
  2665. "receivedEvents": [
  2666. "DEVICE-PROFILE"
  2667. ],
  2668. "createdAt": "2018-01-01T01:00:00Z"
  2669. }
  2670. },
  2671. "CompletedDecision": {
  2672. "summary": "A completed Decision",
  2673. "value": {
  2674. "id": "7c4fd0f3-7066-4c25-8871-3711781f3f25",
  2675. "recipe": "0c1f1ef9-9243-41fb-a1b0-4062728da7c6",
  2676. "reference": "aa4e2f7c-8de7-439b-8b20-85f357b6fea5",
  2677. "requiredEvents": [],
  2678. "receivedEvents": [
  2679. "DEVICE-PROFILE",
  2680. "IDENTITY-DOCUMENTS",
  2681. "SELFIE"
  2682. ],
  2683. "createdAt": "2018-01-01T01:00:00Z",
  2684. "result": 90
  2685. }
  2686. }
  2687. },
  2688. "securitySchemes": {
  2689. "Bearer": {
  2690. "type": "http",
  2691. "scheme": "bearer",
  2692. "bearerFormat": "JWT"
  2693. }
  2694. }
  2695. }
  2696. }
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!