{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ce8c3274-f893-4ee7-8d67-2aaeb8b00acb","name":"Checkboard Client APIs","description":"The **Checkboard API** provides seamless, secure, and efficient identity verification, fund confirmation, payment processing, and document signing services. Designed for fintech applications, our API enables businesses to streamline compliance, enhance security, and optimise user experiences.\n\n## What Can You Do with the Checkboard API?\n\nWith Checkboard’s powerful API, you can:\n\n✅ **Verify Identities** – Authenticate users with robust identity verification tools.  \n✅ **Confirm Funds** – Ensure sufficient funds in a user’s account before transactions.  \n✅ **Process Payments** – Enable secure and compliant payment processing.  \n✅ **Sign Documents** – Digitally sign and verify documents with legally binding solutions.\n\n## Who is This API For?\n\nThe Checkboard API is built for:\n\n- **Fintech Companies** looking to integrate secure financial services.\n    \n- **Lenders & Real Estate Platforms** needing identity and fund verification.\n    \n- **E-commerce & Marketplaces** requiring smooth payment processing.\n    \n- **Regulated Industries** needing compliance-focused document signing.\n    \n\n## How to Get Started\n\n1. **Sign Up &** [Obtain API Keys](#b0ac7a77-0e81-4a69-b646-10273e43e1d8) – Register your account to get your API credentials.\n    \n2. **Review Authentication Methods** – Learn how to securely authenticate API requests.\n    \n3. **Make Your** [First API Call](#d8adfc0d-3990-49eb-96f6-25f93dbebb7a) – Follow our step-by-step guide to initiate your first request.\n    \n\n## Key Features\n\n🚀 **RESTful Architecture** – Easy-to-use endpoints for seamless integration.  \n🔒 **Secure & Compliant** – Built with industry-leading security and regulatory compliance.  \n📖 **Comprehensive Documentation** – Clear guides, code examples, and error handling.  \n⚡ **Fast & Reliable** – High uptime and low-latency responses.\n\nStart integrating **Checkboard API** today and unlock a frictionless digital experience for your users! 🚀\n\n---\n\n# Getting started\n\nTo integrate with Checkboard’s APIs, you will need to obtain a **Bearer Token** and **Client ID**. Please contact the **Checkboard Implementations Team** at [support@checkboard.com](https://mailto:support@checkboard.com) to request these credentials.\n\n## Base URLs\n\nUse the following base URLs to interact with Checkboard's API:\n\n- **Production Environment:** `https://api.checkboard.com/v2`\n    \n- **Sandbox Environment:** `https://api.checkboard.tech/v2`\n    \n\n## **The Checkboard app**\n\nThe Checkboard app is required to complete verification processes.\n\n### **Production**\n\n- Once an invitation is sent, users will be prompted to download the **Checkboard App** to complete their verification.\n    \n\n### **Sandbox (UAT)**\n\n- To test the complete Checkboard process in a sandbox environment, you must manually download the **Checkboard UAT App**.\n    \n- Unlike in production, the app download is **not** automatically prompted via the invitation link.\n    \n\n#### **Download the Checkboard App**\n\n- [<b>Android</b>](https://play.google.com/store/apps/details?id=com.checkboardlondon.app.sb)\n    \n- [<b>iOS</b>](https://testflight.apple.com/join/D45sRZgd)\n    \n\n## **Completing an invitation (Testing Process)**\n\nWhen testing, you will need to input information in the Checkboard app to simulate a client’s experience. Below are specific details for key services within the verification flow:\n\n### **Identity Verification**\n\n- A valid, authentic identity document is required for testing.\n    \n\n### **Banking Integration (Modelo Sandbox)**\n\n- Use the following credentials to access the **Modelo Sandbox** test bank account:\n    \n    - **Username:** `mits`\n        \n    - **Password:** `mits`\n        \n\n### **Simulating Payments**\n\n- Use [<b>Stripe's test card numbers</b>](https://docs.stripe.com/testing?testing-method=card-numbers#cards) to simulate payments during testing.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"17749952","team":3175212,"collectionId":"ce8c3274-f893-4ee7-8d67-2aaeb8b00acb","publishedId":"2s8Ysp1b9i","public":true,"publicUrl":"https://developers.checkboard.com","privateUrl":"https://go.postman.co/documentation/17749952-ce8c3274-f893-4ee7-8d67-2aaeb8b00acb","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0075ff"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/03c7160d-5e75-4f3a-8a8b-711865b98d0b/bG9nbyBibGFjayAybWIucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"0075ff"}},{"name":"light","logo":"https://content.pstmn.io/03c7160d-5e75-4f3a-8a8b-711865b98d0b/bG9nbyBibGFjayAybWIucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0075ff"}}]}},"version":"8.11.6","publishDate":"2026-01-06T19:18:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/03c7160d-5e75-4f3a-8a8b-711865b98d0b/bG9nbyBibGFjayAybWIucG5n","logoDark":"https://content.pstmn.io/03c7160d-5e75-4f3a-8a8b-711865b98d0b/bG9nbyBibGFjayAybWIucG5n"}},"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/c8957d9932406455a66b477735c6f6752e46ccb8b6c334a72ee603bc66d8c131","favicon":"https://res.cloudinary.com/postman/image/upload/v1767167366/team/6df1b5148d80dbb3f3e1655df739920f.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.checkboard.com/view/metadata/2s8Ysp1b9i"}