{"_id":"5a0b0d9b04d0d600269f1383","category":{"_id":"5a0b0d9b04d0d600269f1378","version":"5a0b0d9b04d0d600269f1373","project":"573c7e3b9eef3a0e00b51c58","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-08-29T19:18:51.020Z","from_sync":false,"order":4,"slug":"api","title":"Privakey API Reference"},"project":"573c7e3b9eef3a0e00b51c58","user":"573c88c2fe58321900f1b9b7","version":{"_id":"5a0b0d9b04d0d600269f1373","project":"573c7e3b9eef3a0e00b51c58","__v":1,"createdAt":"2017-11-14T15:36:59.500Z","releaseDate":"2017-11-14T15:36:59.500Z","categories":["5a0b0d9b04d0d600269f1374","5a0b0d9b04d0d600269f1375","5a0b0d9b04d0d600269f1376","5a0b0d9b04d0d600269f1377","5a0b0d9b04d0d600269f1378"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"githubsync":"","__v":9,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-13T20:46:18.814Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"{\n    \"message\": \"Request created successfully.\",\n    \"request_guid\": \"dd17c08a-b2f6-4a7e-8a74-a22809bd5d4d\"\n}","language":"json","status":200},{"status":400,"language":"json","code":"{\n    \"message\": \"createNTypeRequest NType Client not found for id 1clientGuid\"\n}"}]},"method":"post","examples":{"codes":[]},"auth":"required","params":[{"_id":"57d31b7657a8572000c4f25b","ref":"","in":"body","required":true,"desc":"Your client identifier from the Privakey User Portal.","default":"","type":"string","name":"client_id"},{"_id":"57d31b7657a8572000c4f25a","ref":"","in":"body","required":true,"desc":"The subject identifier of the user to send the request.","default":"","type":"string","name":"subject_identifier"},{"_id":"57d31b7657a8572000c4f259","ref":"","in":"body","required":true,"desc":"Message to display to the user, must be 140 characters or less.","default":"","type":"string","name":"message"},{"_id":"57d31b7657a8572000c4f258","ref":"","in":"body","required":true,"desc":"Whether a validation code should be displayed or not.","default":"true","type":"string","name":"should_display_code"},{"_id":"57d31b7657a8572000c4f257","ref":"","in":"body","required":false,"desc":"Custom message to present in the notification to the user. Must be 140 characters or less.","default":"","type":"string","name":"notification_message"},{"_id":"57d31b7657a8572000c4f256","ref":"","in":"body","required":false,"desc":"How long the request should last. Can be any integer followed by s, m, h, or d for time unit.","default":"60s","type":"string","name":"duration"},{"_id":"57d31b7657a8572000c4f255","ref":"","in":"body","required":false,"desc":"Can the user approve the request without using a PIN?","default":"false","type":"string","name":"pinless"}],"url":"/api/ntype"},"isReference":false,"order":0,"body":"Response Keys\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"message\",\n    \"0-1\": \"String that describes if the n type request was generated successfully.\",\n    \"1-0\": \"request_guid\",\n    \"1-1\": \"A guid used to poll if the request was authorized. Use it to call HTTP GET poll-n-type.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","excerpt":"Creates an n-type request.","slug":"create-n-type","type":"endpoint","title":"Create N-Type"}

postCreate N-Type

Creates an n-type request.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

client_id:
required
string
Your client identifier from the Privakey User Portal.
subject_identifier:
required
string
The subject identifier of the user to send the request.
message:
required
string
Message to display to the user, must be 140 characters or less.
should_display_code:
required
stringtrue
Whether a validation code should be displayed or not.
notification_message:
string
Custom message to present in the notification to the user. Must be 140 characters or less.
duration:
string60s
How long the request should last. Can be any integer followed by s, m, h, or d for time unit.
pinless:
stringfalse
Can the user approve the request without using a PIN?

Result Format


Documentation

Response Keys [block:parameters] { "data": { "h-0": "Key", "h-1": "Description", "0-0": "message", "0-1": "String that describes if the n type request was generated successfully.", "1-0": "request_guid", "1-1": "A guid used to poll if the request was authorized. Use it to call HTTP GET poll-n-type." }, "cols": 2, "rows": 2 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}