Get Started with Neobits

Neobits has three REST APIs for banks and lenders: Core authenticates API clients and administers them, Fuse collects and verifies data about a person from public registries, and Logic runs decisions built in the Logic decision engine.

Account Creation

Contact Neobits

Accounts must be created with Neobits customer support.
To get started, please send an email to: hello@neobits.no
With your account you get an API client: its id, its username and its password (the client secret). You send the username and password with HTTP Basic to Core's token endpoint, exactly as you received them, to get the bearer tokens the APIs take. See Core.

Our APIs

Core API

Handles authentication (OAuth 2.0 client credentials) and administration of clients.
  • Supports OAuth 2.0 client credentials
  • Checks the HTTP Basic credentials of legacy clients
  • Comprehensive client administration
  • Secure token management
Explore Core API Documentation →

Fuse API

Collects person data (income, debt, property, family) from public registries, with the person's consent where required, and returns it as one structured, cross-referenced profile.
Learn more about Fuse's capabilities on our website.
Explore Fuse API Documentation →

Logic API

Runs decision models built in the Logic app against JSON input: evaluate a version, manage environments and deployments, and execute a deployed decision from your application.
Explore Logic API Documentation →

Error Handling

Our APIs use consistent error codes and messages to help you handle errors gracefully.
View Error Reference →

Base URLs

Every API is served from hosts that start with your tenant name, which you get from Neobits with your account:
  • Core: https://{tenant}.core.server.test.neobits.ai and https://{tenant}.core.server.prod.neobits.ai
  • Fuse: https://{tenant}.fuse.server.test.neobits.ai and https://{tenant}.fuse.server.prod.neobits.ai
  • Logic: https://{tenant}.logic.server.test.neobits.ai and https://{tenant}.logic.server.prod.neobits.ai

Rate Limits

Requests are rate limited per client IP address, currently at 10,000 requests per minute. A request over the limit gets 429 Too Many Requests with a Retry-After header: the number of seconds to wait before you retry. Retrying sooner only extends the wait.
Core answers in its OAuth 2.0 error format, with {"error":"too_many_requests","error_code":"429-000"}. Fuse and Logic use the standard error format, with {"errors":[{"name":"TooManyRequests","code":"429-000"}]}. Because these requests never reach the API, the response has no timestamp, moreInfo or X-Request-ID.
Reuse access tokens until they expire instead of requesting a new token for every call. For a 429 without Retry-After, retry with exponential backoff and jitter.

Retries and Idempotency

GET requests are safe to retry. Fuse inquiry creation and Logic executions and evaluations accept an Idempotency-Key header; any other retried POST is processed as a new request, so check whether the first attempt succeeded before you send it again.
The Fuse and Logic introductions describe how their write operations behave when repeated.

Versioning

Every API includes its major version in the path, for example /v1/oauth2/token, /v1/deployments and /v2/inquiries. The exception is the discovery document and key set under /.well-known, which are at the root of the host.
Changes, including deprecations, are listed in the release notes for Core, Fuse and Logic.

Machine-Readable Docs

For code generators, API clients and AI coding agents:

Next Steps

After creating your account, you can:
  1. Explore our API documentation
  2. Request access credentials
  3. Test the APIs in the test environment
  4. Integrate with your systems