{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e97f3d44-c1f5-431a-812c-9fdad76909bc","name":"Nitrogen Developer API","description":"Welcome to the Nitrogen API website!\n\nHere you will find detailed information about the various endpoints for the Nitrogen API. The Nitrogen API utilizes OAuth 2.0 with the authorization code flow. For more on OAuth 2.0 with authorization code, see [https://oauth.net/2/grant-types/authorization-code/](https://oauth.net/2/grant-types/authorization-code/)\n\n# Security Policy\n\nWe take breaches of security very seriously at Nitrogen. If you have had a security breach in which any Nitrogen data or credentials may have been compromised, contact us immediately at [apisupport@nitrogenwealth.com](https://mailto:apisupport@nitrogenwealth.com).\n\nWhile the following is not meant to be an exhaustive list, below are some examples of what would constitute a security incident that could cause the temporary suspension or permanent termination of your API access.\n\n1. Use of a non-test Nitrogen account with your test API credentials\n    \n2. Launching your solution to production without first passing Nitrogen's review\n    \n3. Launching your solution to production with your test API credentials\n    \n4. Insecurely handling or transmitting your OAuth client secret. There is NEVER a reason to send us your OAuth client secret outside of our API.\n    \n5. Insecurely handling or transmitting an OAuth auth code, access token, or refresh token. There is NEVER a reason to send us an auth code, access token, or refresh token outside of our API.\n    \n6. Insecurely implementing the Nitrogen API\n    \n7. Allowing one user to see another user’s data\n    \n8. Obtaining, storing, transmitting, or using the username and password of one of our customers\n    \n\nPlease consult your API agreement for further provisions.\n\n# API Access\n\nAccess to the Nitrogen Developer API is by approval only. In order to do this, contact your account representative.\n\nEvery request that your application sends to a Nitrogen API needs to be identified. Once you have obtained API credentials, you can connect to our API with an OAuth 2.0 access token in your request.\n\n# API Calls\n\nNitrogen APIs utilize a RESTful design. This means that you use standard HTTP methods to retrieve and manipulate objects. The base url for Nitrogen APIs is [https://api2.riskalyze.com/](https://api2.riskalyze.com/).\n\n_Note:_ All requests to the API must be made via HTTPS protocol and include proper API credentials.\n\n## Request Methods\n\nThe Nitrogen APIs expose various endpoints for working with resources. Each endpoint supports one or more of the following HTTP request methods:\n\nGET: Used to retrieve an individual resource, a list of resources, or to search resources.\n\nPOST: Used to create a new resource.\n\nPUT: Used to update a resource.\n\nDELETE: Used to remove a resource.\n\n## Response Codes\n\nThe table below describes the most common response codes that you will receive from a request. In addition to the status code, most responses will receive a body with a JSON structure that represents the results of a successful request or additional error information.\n\n200: OK\n\n201: Created - Resource was received and stored successfully\n\n202: Accepted - Resource was received and stored for process at a later time\n\n204: Resource was deleted successfully\n\n400: Bad Request - Response body will contain more information\n\n401: Unauthorized - Response will include the WWW-Authenticate header\n\n403: Forbidden - The requested resource is not assigned to your API key\n\n404: Not Found - The requested resource does not exist at this time\n\n500: Internal Server Error - Something went wrong… try again later\n\n# Quota\n\nCalls to the API must made made in accordance with your API agreement. Please contact your account representative for additional details.\n\n# Data Formats\n\nAt this time, all resources in the Nitrogen APIs are represented using JSON data formats. The details of each resource are documented in the appropriate API. Sometimes the actual resource returned by the API will vary slightly from the representation in that it may include additional properties. If any undocumented data is useful feel free to use it with the understanding that it could disappear at any time. If undocumented properties drive a compelling use case for your application, feel free to let us know and we will consider adding it to the API spec.\n\n# Displaying Risk Numbers\n\nWe offer two methods of displaying Risk Numbers:\n\n**Download** our\n\n<a href=\"https://www.riskalyze.com/style\">art kit</a>\n\n**Generate** Risk Number images via CDN. Generating Risk Number images via our CDN is the **preferred method**. To generate a Risk Number image via our CDN you will need to use an img tag with a URL of the following format: `https://1dc018be4716da4aaa18-5d73971c6ce0cd6d739efc4134c4b48a.ssl.cf2.rackcdn.com/v2/[TYPE]/[SIZE]/r[RISK NUMBER].[file extension (png or svg)]`\n\nWe offer the following types:\n\n| Type | Description | Example |\n| --- | --- | --- |\n| standard | Risk Number with no special formatting. This would be used for a Client Risk Number | <img src=\"https://1dc018be4716da4aaa18-5d73971c6ce0cd6d739efc4134c4b48a.ssl.cf2.rackcdn.com/v2/standard/60/r59.png\" alt=\"\"> |\n| portfolio | Risk Number formatted for displaying a portfolio Risk Number | <img src=\"https://1dc018be4716da4aaa18-5d73971c6ce0cd6d739efc4134c4b48a.ssl.cf2.rackcdn.com/v2/portfolio/60/r59.png\" alt=\"\"> |\n\nWe offer the following sizes, in pixels: 60, 90, 180, 360, and 1000. We also offer the graphics in the svg format. To get an svg, use svg for the size.\n\nRisk Numbers can be 1 through 99. Sending a Risk Number of 0 will return a faded question mark for an unknown Risk Number\n\nExample (png): [https://1dc018be4716da4aaa18-5d73971c6ce0cd6d739efc4134c4b48a.ssl.cf2.rackcdn.com/v2/standard/360/r59.png](https://1dc018be4716da4aaa18-5d73971c6ce0cd6d739efc4134c4b48a.ssl.cf2.rackcdn.com/v2/standard/360/r59.png)\n\nExample (svg): [https://1dc018be4716da4aaa18-5d73971c6ce0cd6d739efc4134c4b48a.ssl.cf2.rackcdn.com/v2/standard/svg/r59.svg](https://1dc018be4716da4aaa18-5d73971c6ce0cd6d739efc4134c4b48a.ssl.cf2.rackcdn.com/v2/standard/svg/r59.svg)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"8586423","collectionId":"e97f3d44-c1f5-431a-812c-9fdad76909bc","publishedId":"SVmsW1M3","public":true,"publicUrl":"https://developers.riskalyze.com","privateUrl":"https://go.postman.co/documentation/8586423-e97f3d44-c1f5-431a-812c-9fdad76909bc","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.11.6","publishDate":"2020-04-01T17:40:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://riskalyze.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://developers.riskalyze.com/view/metadata/SVmsW1M3"}