{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3790170a-5faa-43fe-a779-2cc0d4a6d096","name":"Ivory Partner Integration APIs","description":"## Introduction\n\nThis guide provides a comprehensive overview of how to integrate Ivory's cognitive assessment platform into your product using the Ivory Partner APIs.\n\n---\n\n## Overview\n\nThe Ivory Partner APIs enable partners to:\n\n- Register new users\n    \n- Update existing user information\n    \n- Create cognitive assessments\n    \n- Retrieve all registered users\n    \n- Fetch assessments linked to specific users\n    \n- Fetch a user's details\n    \n- Fetch a particular assessment details\n    \n- Assign Product to User\n    \n- Get all products by User\n    \n- Get user product details\n    \n\nThis Postman Collection includes all available API endpoints, sample request payloads, response structures, and environment configurations to facilitate seamless integration and testing.\n\n---\n\n## Authentication & Access\n\nAll API requests require **two** forms of authentication:\n\n- **API Secret**: Sent via the HTTP header `x-api-secret`\n    \n- **Partner ID**: Shared with you via email\n    \n\nThe **Partner ID** must be included in the payload of every request:\n\n- For **GET** requests, include it as a **query parameter**:  \n    `?partnerId=yourPartnerId`\n    \n- For **POST**, **PUT**, and **DELETE** requests, include it as a **JSON key** inside the request body:\n    \n    ``` json\n                                  {\n                                    \"partnerId\": \"yourPartnerId\",\n                                    ...\n                                  }\n    \n     ```\n    \n\n⚠️ **Note**: API Secret and Partner ID credentials are different for **Test** and **Production** environments and cannot be interchanged.\n\n---\n\n## API Endpoints\n\n- **Test Environment**: `https://test-api.liveivory.com`  \n    _Use only with test credentials_\n    \n- **Production Environment**: `https://api.liveivory.com`  \n    _Use only with production credentials_\n    \n\n---\n\n## Integration Notes\n\n- Every user created via the API is also registered within the Ivory platform.\n    \n- All assessments/userProducts must be associated with an existing Ivory user.\n    \n- Always **create the user first** before initiating an assessment.\n    \n\n---\n\n## Recommended Integration Flow For Products\n\n1. **Create User**\n    \n2. **Assign User Product** for that user.\n    \n3. Redirect the user to **assess.liveivory.com** (or the registered subdomain for your partner) for completion. Alternatively, you can generate a **magic link (pre-signed URL)** for the user and redirect them directly to the assessment.  \n    _Magic links bypass the authentication step, allowing users to start the assessment instantly. This is ideal for deep integrations within your tech ecosystem, enabling a seamless, low-friction user experience._\n    \n4. Once the assessment is complete, use **Get User Product Details** api to fetch details including the final report.\n    \n\n---\n\n**Important Note:**\n\nWhen assigning `externalUserId` and `externalUserProductId`, ensure that you do **not** use a raw MongoDB ObjectID. Using an unmodified ObjectID may conflict with Ivory’s internal MongoDB identifiers.\n\nTo prevent this, prepend the ObjectID with a custom string.\n\n**Example:** `6731cbd22d15c9f31e5d5791` → `\"$MYID:6731cbd22d15c9f31e5d5791\"`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"30763266","team":5728800,"collectionId":"3790170a-5faa-43fe-a779-2cc0d4a6d096","publishedId":"2sB2j1iDCX","public":true,"publicUrl":"https://documentation.liveivory.com","privateUrl":"https://go.postman.co/documentation/30763266-3790170a-5faa-43fe-a779-2cc0d4a6d096","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"162672"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Explore Ivory's Partner API collection to effortlessly integrate cognitive assessment tests into your applications. Complete documentation for user registration, assessment creation, user management, and more, with ready-to-use environments and sample payloads."},{"name":"title","value":"Ivory Partner APIs - Integrate Cognitive Assessment Tests Seamlessly"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/98ed006a-13d7-4bda-b0d1-204e514aa5f6/ZGFya2ZpbmFsX2FwcCBkcmF3ZXIgaWNvbi5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"2997DD"}},{"name":"light","logo":"https://content.pstmn.io/065612f0-de66-4ec3-8936-d93620e86dee/aXZvcnlfc3F1YXJlXzUxMi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"162672"}}]}},"version":"8.10.1","publishDate":"2025-04-28T11:38:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Ivory Partner APIs - Integrate Cognitive Assessment Tests Seamlessly","description":"Explore Ivory's Partner API collection to effortlessly integrate cognitive assessment tests into your applications. Complete documentation for user registration, assessment creation, user management, and more, with ready-to-use environments and sample payloads."},"logos":{"logoLight":"https://content.pstmn.io/065612f0-de66-4ec3-8936-d93620e86dee/aXZvcnlfc3F1YXJlXzUxMi5wbmc=","logoDark":"https://content.pstmn.io/98ed006a-13d7-4bda-b0d1-204e514aa5f6/ZGFya2ZpbmFsX2FwcCBkcmF3ZXIgaWNvbi5wbmc="}},"statusCode":200},"environments":[{"name":"Development","id":"dace9c53-3d90-42f1-a187-627e5a1cc293","owner":"30763266","values":[{"key":"host","value":"https://test-api.liveivory.com","enabled":true,"type":"default"},{"key":"partnerId","value":"your-partner-id","enabled":true,"type":"default"},{"key":"userId","value":"your-user-id","enabled":true,"type":"default"},{"key":"assessmentId","value":"","enabled":true,"type":"any"},{"key":"apiSecret","value":"partner-api-secret","enabled":true,"type":"any"},{"key":"userProductId","value":"user-product-id","enabled":true,"type":"default"}],"published":true}],"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/2b0150e1e809110530ada28f6785b0a46ddd6320f21aa384b64a61e04af80215","favicon":"https://liveivory.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"},{"label":"Development","value":"30763266-dace9c53-3d90-42f1-a187-627e5a1cc293"}],"canonicalUrl":"https://documentation.liveivory.com/view/metadata/2sB2j1iDCX"}