# Neobits API

> REST APIs for the Neobits platform: Core issues OAuth 2.0 tokens and administers API clients, Fuse aggregates financial data about a person (income, debt, property, family), and Logic runs decisions built in the Logic decision engine.

Every API is served from `https://api.test.neobits.ai` and `https://api.prod.neobits.ai`, with its major version in the path (for example `/fuse/v2/inquiries`). Each operation lists its authentication: HTTP basic, or a bearer token from the Core token endpoint.

Every page is also available as markdown: append `.md` to its URL. The full OpenAPI 3.1 document is at https://docs.neobits.ai/openapi.json, and each API has its own (listed below).

Accounts are created by Neobits customer support: email hello@neobits.no.

## Guides

- [Get started](https://docs.neobits.ai/api-reference/get-started.md): accounts, rate limits, retries, idempotency and versioning
- [Errors](https://docs.neobits.ai/api-reference/errors.md): error response formats and every error code
- [Fuse testing](https://docs.neobits.ai/api-reference/tag/fuse/testing.md): test users and credentials for the Fuse API

## Core (Authz)

- [Introduction](https://docs.neobits.ai/api-reference/tag/core-authz.md)
- [OpenAPI document](https://docs.neobits.ai/openapi/core-authz.json)
- [OpenID Connect Configuration](https://docs.neobits.ai/api-reference/operation/getOpenIdConfiguration/method/get.md): GET /core/.well-known/openid-configuration
- [JSON Web Key Set](https://docs.neobits.ai/api-reference/operation/getJwks/method/get.md): GET /core/.well-known/jwks.json
- [Get an OAuth 2.0 token](https://docs.neobits.ai/api-reference/operation/createToken/method/post.md): POST /core/v1/oauth2/token
- [Introspect an OAuth 2.0 token](https://docs.neobits.ai/api-reference/operation/introspectOauthToken/method/post.md): POST /core/v1/oauth2/introspect
- [Introspect a Basic token](https://docs.neobits.ai/api-reference/operation/introspectBasicToken/method/post.md): POST /core/v1/basic/introspect
- [List Clients](https://docs.neobits.ai/api-reference/operation/getClients/method/get.md): GET /core/v1/clients
- [Create Client](https://docs.neobits.ai/api-reference/operation/createClient/method/post.md): POST /core/v1/clients
- [Get Client](https://docs.neobits.ai/api-reference/operation/getClient/method/get.md): GET /core/v1/clients/{client_id}
- [Delete Client](https://docs.neobits.ai/api-reference/operation/deleteClient/method/delete.md): DELETE /core/v1/clients/{client_id}

## Fuse

- [Introduction](https://docs.neobits.ai/api-reference/tag/fuse.md)
- [OpenAPI document](https://docs.neobits.ai/openapi/fuse.json)
- [Create an inquiry](https://docs.neobits.ai/api-reference/operation/inquiries-post/method/post.md): POST /fuse/v2/inquiries
- [Get multiple inquiries (TBA)](https://docs.neobits.ai/api-reference/operation/inquiries-get/method/get.md): GET /fuse/v2/inquiries
- [Delete an inquiry (TBA)](https://docs.neobits.ai/api-reference/operation/inquiry-delete/method/delete.md): DELETE /fuse/v2/inquiries/{inquiryId}
- [Update an inquiry (TBA)](https://docs.neobits.ai/api-reference/operation/inquiry-patch/method/patch.md): PATCH /fuse/v2/inquiries/{inquiryId}
- [Get an inquiry](https://docs.neobits.ai/api-reference/operation/inquiry/method/get.md): GET /fuse/v2/inquiries/{inquiryId}
- [Get a person](https://docs.neobits.ai/api-reference/operation/person/method/get.md): GET /fuse/v2/persons/{ssn}

## Logic

- [Introduction](https://docs.neobits.ai/api-reference/tag/logic.md)
- [OpenAPI document](https://docs.neobits.ai/openapi/logic.json)
- [List environments](https://docs.neobits.ai/api-reference/operation/logic-environments-list/method/get.md): GET /logic/v1/environments
- [Create an environment](https://docs.neobits.ai/api-reference/operation/logic-environments-create/method/post.md): POST /logic/v1/environments
- [Get an environment](https://docs.neobits.ai/api-reference/operation/logic-environments-get/method/get.md): GET /logic/v1/environments/{id}
- [Update an environment](https://docs.neobits.ai/api-reference/operation/logic-environments-update/method/patch.md): PATCH /logic/v1/environments/{id}
- [Delete an environment](https://docs.neobits.ai/api-reference/operation/logic-environments-delete/method/delete.md): DELETE /logic/v1/environments/{id}
- [List deployments](https://docs.neobits.ai/api-reference/operation/logic-deployments-list/method/get.md): GET /logic/v1/deployments
- [Create a deployment](https://docs.neobits.ai/api-reference/operation/logic-deployments-create/method/post.md): POST /logic/v1/deployments
- [Get a deployment](https://docs.neobits.ai/api-reference/operation/logic-deployments-get/method/get.md): GET /logic/v1/deployments/{id}
- [Update a deployment](https://docs.neobits.ai/api-reference/operation/logic-deployments-update/method/patch.md): PATCH /logic/v1/deployments/{id}
- [Delete a deployment](https://docs.neobits.ai/api-reference/operation/logic-deployments-delete/method/delete.md): DELETE /logic/v1/deployments/{id}
- [Execute a decision](https://docs.neobits.ai/api-reference/operation/logic-executions-create/method/post.md): POST /logic/v1/{environmentId}/decisions/{decisionId}/executions
- [Evaluate a decision](https://docs.neobits.ai/api-reference/operation/logic-evaluations-create/method/post.md): POST /logic/v1/decisions/{decisionId}/evaluations

## Optional

- [Full OpenAPI document](https://docs.neobits.ai/openapi.json): every API in one OpenAPI 3.1 document
- [llms-full.txt](https://docs.neobits.ai/llms-full.txt): every page above in one markdown file