Neero SAS

Neero Baas Gateway

<p class="slate-p slate-indent-0" style="0px">Core Offerings: Neero’s Business Solutions</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Financial Management Tools :</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Card Management: Easily create and manage Visa and Mastercard bank cards for employees and customers.</div></li><li class="slate-li " ><div style="position:relative">Salary and Invoice Payments: Automate salary payments and invoice generation, simplifying payroll and billing processes.</div></li><li class="slate-li " ><div style="position:relative">Money Transfers: Facilitate quick and secure money transfers within and across borders.</div></li><li class="slate-li " ><div style="position:relative">Team Budget Management: Monitor and control team budgets with real-time tracking and reporting.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Neero Gateway :</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">International and Local Payment Methods: Accept payments from various channels, ensuring flexibility and convenience for your customers.</div></li><li class="slate-li " ><div style="position:relative">Neero flow : Ideal for businesses that manage payments on behalf of third parties, such as marketplaces, on-demand service platforms, and crowdfunding sites. It simplifies the complexity of multi-party payments by enabling quick user onboarding, automated fund distribution, and robust compliance and security management.</div></li><li class="slate-li " ><div style="position:relative">Instant Transfers: Diaspora companies can transfer funds instantly to recipients in Africa, enhancing operational efficiency.</div></li><li class="slate-li " ><div style="position:relative">Security Features: Tools like dispute resolution and Katika ensure that every transaction is protected, fostering a safe environment for both businesses and consumers.</div></li></ul></li></ul><p class="slate-p slate-indent-0" style="0px">Security and Trust : Building Confidence in Neero</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Transaction Security :</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Dispute Resolution : Our integrated dispute resolution system ensures that all parties have recourse in the event of transaction issues, maintaining trust.</div></li><li class="slate-li " ><div style="position:relative">Neero Radar : This security feature monitors transactions in real-time, flagging suspicious activity to prevent fraud and unauthorized access.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Compliance and Regulation :</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Regulatory Adherence: Neero complies with local and international financial regulations, ensuring that your business operations are always within legal frameworks.</div></li><li class="slate-li " ><div style="position:relative">Data Protection: We prioritize data security, employing advanced encryption and storage techniques to safeguard sensitive information.</div></li></ul></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Why Choose Neero Gateway ?</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Ease of Integration : </strong>Our API is designed for quick and seamless integration, allowing businesses to start accepting payments without significant delays.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Customer Support :</strong> Neero offers 24/7 support to assist with any technical issues or queries, ensuring a smooth user experience.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Incentives for Implementation :</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Exclusive Offers: Take advantage of discounts or bonuses when you implement Neero Gateway within the next few months.</div></li><li class="slate-li " ><div style="position:relative">Referral Program: Earn rewards by referring other businesses to Neero, fostering a network of trusted partners.</div></li></ul></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Scalability :</strong></div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Growth with Neero: As your business expands, Neero Gateway scales with you, offering advanced features and higher transaction limits to meet your growing needs.</div></li></ul></li></ul><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Continuous Improvement:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Feature Updates : Stay ahead with regular updates that introduce new features and enhancements, keeping your business competitive.</div></li><li class="slate-li " ><div style="position:relative">Feedback Mechanism : We value your input—share your experiences and suggestions to help us refine and improve our services.</div></li><li class="slate-li " ><div style="position:relative">Community and Networking:</div><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">User Community: Join our community of Neero users to exchange best practices, success stories, and innovative ideas, creating a collaborative environment for growth.</div></li></ul></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

Neero offers

<p class="slate-p " >The Neero API is organized around <code class="slate-code">REST</code>. Our API has predictable resource-oriented URLs, accepts <code class="slate-code">form-encoded</code> request bodies, returns <a href="http://www.json.org/" target="_blank"><code class="slate-code">JSON-encoded</code></a>responses, and uses standard HTTP response codes, authentication, and verbs.</p><p class="slate-p " >You can use the Neero API in test mode, which doesn’t affect your live data or interact with the banking networks. The API key you use to <code class="slate-code">authenticate</code> the request determines whether the request is live mode or test mode.</p><p class="slate-p " >The Neero API doesn’t support bulk updates. You can work on only one object per request.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Getting Started

<p class="slate-p" placeholder="Type / for widgets">All API calls need to be authenticated using a secret key. You can get this secret key from your merchant dashboard or contact us to acquire one.</p><p class="slate-p" placeholder="Type / for widgets">We use Basic Authentication to pass the Secret Key. This key is passed in the user field and the password field is left empty.</p><p class="slate-p" placeholder="Type / for widgets">You can view and manage the keys in the Neero Dashboard.</p><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Test mode</strong> and <strong class="slate-bold">live mode</strong> keys are distinguished by their prefixes.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Security Reminder</strong>: Your API keys are powerful, so keep them safe. Don’t share them in public places like GitHub or in client-side code.</div></li></ul><p class="slate-p" placeholder="Type / for widgets">All API requests must be made over HTTPS. Requests made over plain HTTP or without proper authentication will fail.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets">Below is an example request on how we to use the secret key in a request.</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-19-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">curl --location &apos;https://api.dev.neero.io/payment-gateway/api/v1/payment-methods&apos; -u &apos;test_secret_key&apos; --header &apos;Content-Type: application/json&apos; --data-raw &apos;{
&quot;type&quot;:&quot;PAYPAL&quot;,
&quot;paypalDetails&quot;:{
&quot;email&quot;:&quot;florianlowe@gmail.com&quot;,
&quot;countryIso&quot;:&quot;FR&quot;
}}&apos;</div></code></pre><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Authentication

<p class="slate-p" placeholder="Type / for widgets">The payloads consumed and produced by the API are strictly JSON encoded data or HTTP query parameters.</p><p class="slate-p" placeholder="Type / for widgets"></p>

Request and Responses Payloads

Errors

<p class="slate-p slate-indent-0" style="0px">What&apos;s a webhook?</p><p class="slate-p slate-indent-0" style="0px">A webhook is a way for one application to send real-time information to another application. Think of it like a phone call where one app tells another app, &quot;Hey, something just happened, and here’s the details.&quot;</p><p class="slate-p slate-indent-0" style="0px">What Does a Webhook Do?</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Real-Time Updates: When something significant happens in an application (like a payment being processed or a new user signing up), a webhook sends an instant update to another system. This means you don’t have to wait for the other system to check for updates; it gets them immediately.</div></li><li class="slate-li " ><div style="position:relative">Automation: Webhooks can trigger automatic actions. For example, if a customer makes a purchase, a webhook can automatically update the inventory and send a confirmation email.</div></li><li class="slate-li " ><div style="position:relative">Communication: It’s a way for different systems or apps to communicate with each other without needing constant manual intervention.</div></li></ul><p class="slate-p slate-indent-0" style="0px">In short, webhooks help keep different systems in sync and allow them to respond quickly to changes.</p><p class="slate-p slate-indent-0" style="0px">Why use webhooks ?</p><p class="slate-p slate-indent-0" style="0px">When integrating with Neero, you might want your application to receive real-time events from your Neero account so your backend systems can react appropriately.</p><p class="slate-p slate-indent-0" style="0px">Insert line aboveInsert line belowDelete</p><p class="slate-p slate-indent-0" style="0px">To set this up, you need to register webhook endpoints. Once registered, Neero will send real-time event data to your application&apos;s webhook endpoint whenever events occur in your Neero account. Neero uses HTTPS to deliver these events as JSON payloads containing an Event object.</p><p class="slate-p slate-indent-0" style="0px">Insert line aboveInsert line belowDelete</p><p class="slate-p slate-indent-0" style="0px">Receiving webhook events is especially useful for tracking asynchronous events, such as when a customer&apos;s bank confirms a payment, a charge is disputed, a recurring payment is successful, or subscription payments are collected.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Webhook

<p class="slate-p " >You can set a url in your merchant dashboard in order to receive various webhook events. </p><h2 class="slate-h2 " >Structure</h2><p class="slate-p " >All webhook events have the same basic stucture. Below is an example</p><div class="slate-div"></div><h2 class="slate-h2 " >Webhook Verification</h2><p class="slate-p " >Webhooks are sent over the internet. Therefore, you need a mechanism to make sure that the webhooks you receive actually come from us.</p><p class="slate-p " >First you need to retrieve your API&apos;s Webhook Secret. Similar to the secret key, you can get this from your merchant dashboard or contact us.</p><p class="slate-p " ></p><p class="slate-p " >Here is a sample Javascript code on how to verify a webhook request</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const crypto = require(&apos;crypto&apos;);</div><div class="slate-code_line"></div><div class="slate-code_line">function checkSignature(request) {
const timeStamp = request.headers[&apos;X-TIMESTAMP&apos;];
const webhookSecret = &apos;get this from your server&apos;s properties&apos;; // Replace with actual secret</div><div class="slate-code_line">// Assuming &apos;request.body()&apos; returns the body content as a string</div><div class="slate-code_line">const bodyContent = request.body; // Replace with actual way to get request body</div><div class="slate-code_line"></div><div class="slate-code_line">const stringToSign = timeStamp + bodyContent;</div><div class="slate-code_line"></div><div class="slate-code_line">// Calculate HMAC using SHA-512 algorithm</div><div class="slate-code_line">const hmac = crypto.createHmac(&apos;sha512&apos;, webhookSecret);</div><div class="slate-code_line">hmac.update(stringToSign);</div><div class="slate-code_line">const calculatedSignature = hmac.digest(&apos;hex&apos;);</div><div class="slate-code_line"></div><div class="slate-code_line">const signatureFromRequest = request.headers[&apos;X-SIGNATURE&apos;];</div><div class="slate-code_line"></div><div class="slate-code_line">return calculatedSignature === signatureFromRequest;</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " >  </p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The webhook endpoint object

parties management

list Nationalities

list Required Documents

create Onboarding Session

upload Documents

submit Onboarding Session

get Onboarding Session

get Onboarding Session Party

get Party Object

get Active Party Object

list Onboarding Session Party

list Party

card issuing

Card Online Transactions Webhook

freeze Card

Create Virtual Card

get View Details Link

get Saved View Card Details

terminate Card

Neero Payment Gateway

Default

Production

Sandbox

<p class="slate-p " >The <strong class="slate-bold">Neero Baas API</strong> is a modular banking API platform designed for fintechs, digital banks, and any organization looking to embed financial services into their applications. It provides out-of-the-box capabilities for managing customer lifecycle (onboarding, verification), cards (issuance, retrieval, freeze, termination), and will soon support additional core banking services, all through a standardized RESTful API.</p><p class="slate-p " >This API is part of a <strong class="slate-bold">Banking-as-a-Service (BaaS)</strong> strategy that enables:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Rapid integration</strong> of banking services into your business workflows; </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Granular control</strong> over entities (clients, cards, accounts) through well-scoped endpoints; </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">KYC compliance</strong>, via automated document collection and session status tracking; </div></li><li class="slate-li " ><div style="position:relative">A <strong class="slate-bold">scalable and secure architecture</strong>, with authentication and JSON-structured responses.</div></li></ul><p class="slate-p " >Operations are organized around <strong class="slate-bold">independent business modules</strong>, allowing flexible coupling with CRM, ERP, or mobile/web frontend systems.</p><h3 class="slate-h3 " >Key Use Cases</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Issuing a virtual card for a newly verified customer; </div></li><li class="slate-li " ><div style="position:relative">Creating onboarding sessions with document upload; </div></li><li class="slate-li " ><div style="position:relative">Retrieving detailed KYC data (personal info, address, contact) for a party; </div></li><li class="slate-li " ><div style="position:relative">Temporarily freezing a suspicious card; </div></li><li class="slate-li " ><div style="position:relative">Securely displaying card details; </div></li><li class="slate-li " ><div style="position:relative">Listing and filtering entities or sessions by status. </div></li></ul><div class="slate-div"><p class="slate-p " >The API is versioned and follows strict REST conventions (HTTP verbs, stateless design), making it easily consumable by various clients — backend Java, NodeJS, Flutter/Dart, etc.</p><p class="slate-p " ></p></div><h3 class="slate-h3 " ><strong class="slate-bold">Important Terminology</strong></h3><p class="slate-p " ><strong class="slate-bold">Card Category</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">value</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">PHYSICAL</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A physical card that can be used at ATMs and POS terminals.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">VIRTUAL</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >A digital-only card typically used for online transactions.</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Virtual Card Statuses</strong></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Name</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PRE_ACTIVE</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The status right after the card is created</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ACTIVE</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The card can accept transactions</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >FROZEN</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Card cannot accept transctions but still exists</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >TERMINATED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Card has been deleted</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >IN_TERMINATION</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Card is in the process of being deleted</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >SUSPENDED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Neero has internally stopped all transactions on the card.</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Party Capacity</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:254px;">Code</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:254px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><span style="color:#000000"><strong class="slate-bold">CAN_MANAGE_CARDS</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Grants the user permission to manage and configure payment cards.</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Party Contact Point</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:254px;">Type</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:254px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><span style="color:#000000"><strong class="slate-bold">EMAIL</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Contact method using an email address.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><span style="color:#000000"><strong class="slate-bold">PHONENUMBER</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Contact method using a phone number.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><span style="color:#000000"><strong class="slate-bold">SITEWEB</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Contact method via a personal or business website.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-0" style="0px"><span style="color:#000000"><strong class="slate-bold">SOCIALNETWORK</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Contact method via a social network profile or platform.</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Party Location</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:254px;">Type</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:254px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">DELIVERYPOINTADDRESS</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The address used for receiving deliveries or correspondence.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">DOMICILEADDRESS</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The residential address of the individual.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">PLACEOFBIRTH</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The address where the person was born.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">WORKADDRESS</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The individual’s current place of work address.</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Party Onboarding Session Status</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:254px;">Type</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:254px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">INIT</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Initial state of the onboarding process.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">WAITING_FOR_INFORMATION</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The process is waiting for required information to proceed.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">UNDER_VERIFICATION</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The submitted documents and data are currently being verified.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">REFUSED</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The onboarding process has been rejected.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">REFUSED_TIMEOUT</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The onboarding request was automatically rejected due to inactivity or timeout.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">VERIFIED</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The party has successfully passed the verification process.</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Party type</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:254px;">Type</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:254px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">ORGANISATION</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Represents a legal entity or business organization. This type may include company registration details, legal representatives, and official headquarters.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">PERSON</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Represents a natural person, such as an individual customer or user. This type includes personal identity details, birthdate, nationality, and residential address.</p></td></div></tr></tbody></table></div><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Party Required document group type</strong></p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:254px;">Type</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:254px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">ALL_REQUIRED</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Indicates that <strong class="slate-bold">all documents</strong> listed in the group are mandatory and must be submitted.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#000000"><strong class="slate-bold">ANY_REQUIRED</strong></span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Indicates that <strong class="slate-bold">at least one document</strong> from the group can be submitted to proceed.</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><p class="slate-p " ></p>

 is a modular banking API platform designed for fintechs, digital banks, and any organization looking to embed financial services into their applications. It provides out-of-the-box capabilities for managing customer lifecycle (onboarding, verification), cards (issuance, retrieval, freeze, termination), and will soon support additional core banking services, all through a standardized RESTful API.

, allowing flexible coupling with CRM, ERP, or mobile/web frontend systems.

value

Description

Name

Code

Type

<p class="slate-p " >The Neero API is organized around <code class="slate-code">REST</code>. Our API has predictable resource-oriented URLs, accepts <code class="slate-code">form-encoded</code> request bodies, returns <a href="http://www.json.org/" target="_blank"><code class="slate-code">JSON-encoded</code></a>responses, and uses standard HTTP response codes, authentication, and verbs.</p><p class="slate-p " >You can use the Neero API in test mode, which doesn’t affect your live data or interact with the banking networks. The API key you use to <code class="slate-code">authenticate</code> the request determines whether the request is live mode or test mode.</p><p class="slate-p " >The Neero API doesn’t support bulk updates. You can work on only one object per request.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

. Our API has predictable resource-oriented URLs, accepts 

responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the Neero API in test mode, which doesn’t affect your live data or interact with the banking networks. The API key you use to 

 the request determines whether the request is live mode or test mode.

The Neero API doesn’t support bulk updates. You can work on only one object per request.

<p class="slate-p slate-indent-0" style="0px">What&apos;s a webhook?</p><p class="slate-p slate-indent-0" style="0px">A webhook is a way for one application to send real-time information to another application. Think of it like a phone call where one app tells another app, &quot;Hey, something just happened, and here’s the details.&quot;</p><p class="slate-p slate-indent-0" style="0px">What Does a Webhook Do?</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Real-Time Updates: When something significant happens in an application (like a payment being processed or a new user signing up), a webhook sends an instant update to another system. This means you don’t have to wait for the other system to check for updates; it gets them immediately.</div></li><li class="slate-li " ><div style="position:relative">Automation: Webhooks can trigger automatic actions. For example, if a customer makes a purchase, a webhook can automatically update the inventory and send a confirmation email.</div></li><li class="slate-li " ><div style="position:relative">Communication: It’s a way for different systems or apps to communicate with each other without needing constant manual intervention.</div></li></ul><p class="slate-p slate-indent-0" style="0px">In short, webhooks help keep different systems in sync and allow them to respond quickly to changes.</p><p class="slate-p slate-indent-0" style="0px">Why use webhooks ?</p><p class="slate-p slate-indent-0" style="0px">When integrating with Neero, you might want your application to receive real-time events from your Neero account so your backend systems can react appropriately.</p><p class="slate-p slate-indent-0" style="0px">Insert line aboveInsert line belowDelete</p><p class="slate-p slate-indent-0" style="0px">To set this up, you need to register webhook endpoints. Once registered, Neero will send real-time event data to your application&apos;s webhook endpoint whenever events occur in your Neero account. Neero uses HTTPS to deliver these events as JSON payloads containing an Event object.</p><p class="slate-p slate-indent-0" style="0px">Insert line aboveInsert line belowDelete</p><p class="slate-p slate-indent-0" style="0px">Receiving webhook events is especially useful for tracking asynchronous events, such as when a customer&apos;s bank confirms a payment, a charge is disputed, a recurring payment is successful, or subscription payments are collected.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

A webhook is a way for one application to send real-time information to another application. Think of it like a phone call where one app tells another app, "Hey, something just happened, and here’s the details."

In short, webhooks help keep different systems in sync and allow them to respond quickly to changes.

When integrating with Neero, you might want your application to receive real-time events from your Neero account so your backend systems can react appropriately.

To set this up, you need to register webhook endpoints. Once registered, Neero will send real-time event data to your application's webhook endpoint whenever events occur in your Neero account. Neero uses HTTPS to deliver these events as JSON payloads containing an Event object.

Receiving webhook events is especially useful for tracking asynchronous events, such as when a customer's bank confirms a payment, a charge is disputed, a recurring payment is successful, or subscription payments are collected.

nationality

partyType

partyobject

expirationDateTime

status

merchantkey

store_id

partyKey

requiredDocument

files

documentType

sessionId

operator_id

createdAt

name

onboardingSessionKey

onboardingSessionStatus

type

partyInfo

isActive

isDeleted

locations

contactPoints

capacities

documents

partyId

Filter onboarding session with keys greater than this set value

startingAfter

Filter onboarding session with keys  less than this set value

endingBefore

limit

The most common ISO Date Time Format yyyy-MM-dd'T'HH:mm:ss

createdAt.lt

createdAt.lte

createdAt.gt

createdAt.gte

createdAt.eq

Filter party with keys  greather than this set value

Filter party with keys  less than this set value

<p class="slate-p " >The card-controller section provides functionality for managing card-related actions within the system. Users can freeze, view details, terminate, and perform other operations on cards through this section. It serves as a central hub for handling card-related tasks efficiently.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The card-controller section provides functionality for managing card-related actions within the system. Users can freeze, view details, terminate, and perform other operations on cards through this section. It serves as a central hub for handling card-related tasks efficiently.

Sections