{"openapi":"3.1.0","info":{"version":"1.13.0","title":"Fuse API | Neobits","contact":{"email":"hello@neobits.no","url":"https://neobits.ai"},"description":"# Fuse\n\nOpenAPI document for this API: https://docs.neobits.ai/openapi/fuse.json\n\nFuse is a unified data aggregation API that provides fully structured, calculated, and cross-referenced person data through a single integration point. Built for banks, lenders, and regulated environments, Fuse delivers actionable insights that power better decision-making across your organization.\n\nInstead of connecting to 10+ separate APIs to gather customer information, Fuse consolidates all your data needs into one streamlined integration—significantly reducing development time and ongoing maintenance overhead.\n\n \n\n## Key Benefits\n\nUnified Customer Profile — Fuse incorporates advanced logic for inferring, calculating, and matching data from diverse sources to construct a comprehensive customer profile. Data is automatically cross-referenced and validated to ensure accuracy and completeness.\n\nSingle Integration Point — Access personal data from multiple registries through one API. This reduces the complexity of managing multiple vendor relationships, credentials, and integration contracts.\n\nCost Efficiency — Repeated and duplicate customer applications often lead to higher API expenses with minimal benefit. Fuse enables you to efficiently search and reuse data from previous inquiries at no additional cost, optimizing your data spend.\n\n \n\n## Core Concepts\n\nFuse is built around two primary resources: Inquiries and Persons.\n\nInquiry — An Inquiry represents a data collection process for a specific person. When you need to gather information about a customer, you create an Inquiry. The Inquiry tracks what data has been requested, what consent has been obtained, and serves as the container for all fetched person data.\n\nPerson — A Person represents the individual whose data is being collected. Person data is always accessed within the context of an Inquiry, ensuring proper consent and audit trails.\n\n \n\n## Consent Flow\n\nSome data sources require explicit consent from the end user before their data can be accessed. When fetching consent-protected information, the following flow applies:\n\n1. Create an Inquiry — Initialize an Inquiry for the person using their national identity number.\n\n2. Redirect for Consent — If the requested data requires consent, direct the end user to complete the consent process. The Inquiry status will indicate when consent is pending.\n\n3. User Completes Consent — The end user authenticates and grants permission for their data to be accessed.\n\n4. Fetch Person Data — Once the Inquiry is completed, you can fetch the person data. Fuse aggregates information from all connected registries and returns a unified response.\n\n \n\n## Data Reuse\n\nPreviously fetched data remains available within an Inquiry, allowing you to query additional information without re-fetching from source systems. You can also search for existing Inquiries to reuse data from previous requests, reducing costs and improving response times.\n\n \n\n## Getting Started\n\nIn order to consume this API, you must register Neobits as a provider in Altinn. Access must be provided for the Norwegian Population Registry and Samtykkebasert Lånesøknad.\n\nOnce your Altinn access is configured, you can authenticate using your API credentials and begin making requests to the Fuse endpoints documented below.\n\n \n\n## Authentication and Scopes\n\nFuse endpoints use Basic authentication with your client's username and password. Each endpoint requires a scope, which must be assigned to your client directly or through its role. A missing scope returns `403`.\n\n- Create an inquiry: `inquiry:write`\n- Get an inquiry: `inquiry:read`\n- Complete an inquiry: `inquiry:update`\n- Get a person: `person:read`\n\n \n\n## Retries and Idempotency\n\nCreating an inquiry supports an `Idempotency-Key` header. Send a unique key of up to 128 characters, such as a UUID, with each `POST /fuse/v2/inquiries` and send the same key when you retry that request. Keep the following in mind before retrying a request:\n\n- A repeated key returns `201 Created` with the inquiry the first request created, in its current state. Its notifications are not sent again. Keys are scoped to your client and do not expire.\n \n- Repeating a key with another `ssn` or `externalId` returns `409 Conflict` with code `409-002`. Send a new key instead of retrying.\n \n- A non-2xx response does not store the key, so a retry with the same key creates the inquiry and sends its notifications. If sending notifications fails, the inquiry the failed request created is kept but no longer holds the key.\n \n- Repeating a key while the first request is still sending its notifications, or while it fails, returns `409 Conflict` with code `409-000`. Retry it with the same key.\n \n- Without the header, every `POST /fuse/v2/inquiries` creates a new inquiry with a new ID and sends the requested notifications again. The `externalId` is stored as given; it is not required to be unique and does not deduplicate requests.\n \n- `GET` requests are safe to retry.\n \n- An inquiry can be completed once. Completing it again returns `409 Conflict`, and a completion is recorded for usage only once per inquiry.\n\n## Endpoints\n\n- [Create an inquiry](https://docs.neobits.ai/api-reference/operation/inquiries-post/method/post.md): `POST /fuse/v2/inquiries`\n- [Get multiple inquiries (TBA)](https://docs.neobits.ai/api-reference/operation/inquiries-get/method/get.md): `GET /fuse/v2/inquiries`\n- [Delete an inquiry (TBA)](https://docs.neobits.ai/api-reference/operation/inquiry-delete/method/delete.md): `DELETE /fuse/v2/inquiries/{inquiryId}`\n- [Update an inquiry (TBA)](https://docs.neobits.ai/api-reference/operation/inquiry-patch/method/patch.md): `PATCH /fuse/v2/inquiries/{inquiryId}`\n- [Get an inquiry](https://docs.neobits.ai/api-reference/operation/inquiry/method/get.md): `GET /fuse/v2/inquiries/{inquiryId}`\n- [Get a person](https://docs.neobits.ai/api-reference/operation/person/method/get.md): `GET /fuse/v2/persons/{ssn}`"},"servers":[{"url":"https://api.test.neobits.ai"},{"url":"https://api.prod.neobits.ai"}],"tags":[{"name":"Fuse"}],"paths":{"/fuse/v2/inquiries":{"post":{"operationId":"inquiries-post","tags":["Fuse"],"summary":"Create an inquiry","description":"
\n
\n ❗\n

Authorization Required

\n
\n
\n
This endpoint requires authentication via the Core API Auth server.
\n Learn about authentication →\n
\n
\n\n
\n\n\n
\nIf you plan on fetching data that requires prior consent from the user, \nthen you must create an inquiry via this endpoint, and send the user to the inquiry url first. \nSee the GET /persons/{ssn} endpoint documentation to see what data you can fetch with/without \nprior consent from the user.\n
\n\n
\n\n
\nThis endpoint returns a link to Neobits' app where Neobits will \ntake the person through the steps necessary to provide their consent and share their data.\nAfter the user consents to share their data, they will be redirected to the URL(s) you \ndecide as part of the request body to this endpoint (see request body schema).\n
\n\n
\n\n

Error handling

\n\n
\nErrors are attached to the error redirect URL as query parameters. When the user is redirected, the consumer of the API can read the error details to handle it appropriately.\n
\n\n
\nExample error redirect:\n
\n\n
\nhttps://redirect.example.com/error?name=InternalServerError&code=500-001&message=An+internal+server+error+occurred\n
\n\n
\nThe redirect URL includes three query parameters:\n
\n\n\n\n
\n
\n 📖\n

Complete Error Reference

\n
\n
\n
For a complete list of all possible error codes and their descriptions, see the error documentation.
\n View all error codes →\n
\n
","security":[{"basic":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Client-chosen key, such as a UUID, that makes a retry safe. A repeated key returns the stored 201 response without running the request again. Reusing a key with a different request returns 409. A non-2xx response does not store the key.","schema":{"type":"string","minLength":1,"maxLength":128},"example":"7f9c2ba4-e88f-4f2e-9b1d-1f3c6a0e5d21"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"CreateInquiryRequestBody","type":"object","required":["redirect","ssn"],"properties":{"ssn":{"type":"string","example":"01029413157","description":"The unique identifier for the person"},"externalId":{"type":"string","example":"CAN_BE_ANY_STRING","description":"Optional identifier the consumer of the API can provide."},"skipConsentMessages":{"type":"boolean","example":true,"description":"Will skip messages explaining to the user which consents are needed to complete the flow."},"notifications":{"type":"array","description":"The notification array allows the consumer of the API to trigger text message and emails to alert the customer","items":{"type":"object","title":"NotificationOptions","required":["type","message","to"],"properties":{"type":{"type":"string","enum":["SMS"],"example":"SMS"},"message":{"type":"string","example":"Hei. For å dele din informasjon med Bank Bankersen ASA, vennligst gå til denne lenken $link","description":"The consumer of the API can decide where to place the link to initate the process by passing in $link (see example)"},"to":{"type":"string","example":"12345678","description":"The phone number you want the text message to be sent to"}}}},"redirect":{"type":"object","title":"RedirectOptions","description":"URL's provided here will decide where the user should be sent on flow completion","properties":{"onSuccess":{"type":"string","description":"URL to send the user to after the data is fetched","format":"url","example":"https://your.frontend.com/success"},"onError":{"type":"string","description":"URL to send the user to when an error occurs. See the \"Error handling\" section above for more info.","format":"url","example":"https://your.frontend.com/error"}}}}}}}},"responses":{"201":{"description":"Created","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"Location":{"description":"The location of the created inquiry in the form of a resource url","schema":{"type":"string","format":"url","example":"https://api.test.neobits.ai/fuse/v1/persons/01029413157/inquiries/0679c533-5061-496e-8dc5-df786f04a209"}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"type":"object","title":"Inquiry","properties":{"id":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"},"ssn":{"type":"string","example":"01029413157","description":"The unique identifier for the person the inquiry is for."},"url":{"example":"https://informasjonsinnhenting.prod.neobits.ai?applicationState=ey12345","format":"uri","type":"string","description":"Give this URL to the user so they can start the flow."},"externalId":{"type":"string","example":"CAN_BE_ANY_STRING","description":"Optional identifier the consumer of the API can provide."},"skipConsentMessages":{"type":"boolean","example":true,"description":"Will skip messages explaining to the user which consents are needed to complete the flow."},"isCompleted":{"type":"boolean","example":false,"description":"Indicates if the inquiry is completed or not by the user."},"createdAt":{"type":"string","format":"date-time","example":"2019-09-07T15:50:00Z","description":"Inquiry created date"},"updatedAt":{"type":"string","format":"date-time","example":"2019-09-07T15:50:00Z","description":"Inquiry last updated date"},"notifications":{"type":"array","description":"The notification options set for the inquiry.","items":{"type":"object","title":"NotificationOptions","required":["type","message","to"],"properties":{"type":{"type":"string","enum":["SMS"],"example":"SMS"},"message":{"type":"string","example":"Hei. For å dele din informasjon med Bank Bankersen ASA, vennligst gå til denne lenken $link","description":"The consumer of the API can decide where to place the link to initate the process by passing in $link (see example)"},"to":{"type":"string","example":"12345678","description":"The phone number you want the text message to be sent to"}}}},"redirect":{"type":"object","title":"RedirectOptions","description":"URL's provided here will decide where the user should be sent on flow completion","properties":{"onSuccess":{"type":"string","description":"URL to send the user to after the data is fetched","format":"url","example":"https://your.frontend.com/success"},"onError":{"type":"string","description":"URL to send the user to when an error occurs. See the \"Error handling\" section above for more info.","format":"url","example":"https://your.frontend.com/error"}}},"metadata":{"type":"object","properties":{"sbl":{"type":"object","properties":{"authCode":{"type":"string","example":"0679c533-5061-496e-8dc5-df786f04a209","description":"Auhtorization code received from Altinn. Used to retrieve the customers data from Skatteetaten."}}}}},"prerequisites":{"type":"array","description":"Prerequisites are actions that the user must complete before the data can be fetched. They can either be consents that must be given, or flows that must be completed.","items":{"type":"object","title":"Prerequisite","description":"Prerequisites are actions that the user must complete before the data can be fetched. They can either be consents that must be given, or flows that must be completed.","properties":{"name":{"type":"string","enum":["SBL"],"example":"SBL"},"isCompleted":{"type":"boolean","description":"Whether the prerequisite has been completed or not. When the prerequisite requires the user to give prior consent, this field will be true if the user has given consent."},"consentUrl":{"type":["string","null"],"description":"The URL neobits will redirect the user to internally, so the user can complete the prerequisite.","format":"uri"}}}}}}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"BadRequestResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["BadRequest"],"example":"BadRequest"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["400-000","400-001","400-002","400-003","400-004","400-005","400-006","400-007","400-008","400-100","400-101","400-102","400-103","400-104","400-105","400-106","400-107","400-108","400-109","400-110","400-111","400-112"],"example":"400-001"},"message":{"type":"string","example":"Field 'ssn' is required"}}}}}}}}},"401":{"description":"Unauthorized","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"UnauthorizedResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Unauthorized"],"example":"Unauthorized"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["401-000","401-001","401-002","401-003","401-004","401-005","401-006","401-007"],"example":"401-000"},"message":{"type":"string","example":"Client is not authenticated"}}}}}}}}},"403":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ForbiddenResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Forbidden"],"example":"Forbidden"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["403-000","403-001"],"example":"403-000"},"message":{"type":"string","example":"Client does not have access to this resource"}}}}}}}}},"404":{"description":"Not Found","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"NotFoundResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["NotFound"],"example":"NotFound"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["404-000","404-001","404-002"],"example":"404-000"},"message":{"type":"string","example":"The requested resource was not found"}}}}}}}}},"409":{"description":"Conflict","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ConflictResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Conflict"],"example":"Conflict"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["409-000","409-001","409-002"],"example":"409-000"},"message":{"type":"string","example":"A resource with this identifier already exists"}}}}}}}}},"429":{"description":"Too Many Requests. When the rate limit rejects a request, the response carries `Retry-After` and only the `errors` field: no `timestamp`, `moreInfo` or `X-Request-ID`, as the request never reached the API.","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"Retry-After":{"description":"Seconds to wait before retrying. Sent when the rate limit rejects a request.","schema":{"type":"integer","example":60}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TooManyRequestsResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["TooManyRequests"],"example":"TooManyRequests"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["429-000"],"example":"429-000"},"message":{"type":"string","example":"Too many requests. Please try again later."}}}}}}}}},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"InternalServerErrorResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["InternalServerError"],"example":"InternalServerError"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["500-000","500-001"],"example":"500-000"},"message":{"type":"string","example":"An unexpected internal error occurred"}}}}}}}}},"503":{"description":"Service Unavailable","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ServiceUnavailableResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["ServiceUnavailable"],"example":"ServiceUnavailable"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["503-000"],"example":"503-000"},"message":{"type":"string","example":"An error occurred while interacting with a third party service"}}}}}}}}},"504":{"description":"Gateway Timeout","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TimeoutResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["GatewayTimeout"],"example":"GatewayTimeout"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["504-000"],"example":"504-000"},"message":{"type":"string","example":"The request timed out"}}}}}}}}}}},"get":{"operationId":"inquiries-get","tags":["Fuse"],"summary":"Get multiple inquiries (TBA)","description":"
❗

Authorization Required

This endpoint requires authentication via the Core API Auth server.
Learn about authentication →
\n
\n
Get multiple inquiries at a time. Supports cursor-based pagination.
","security":[{"basic":[]}],"parameters":[{"in":"query","required":false,"name":"filter[isCompleted]","example":"false","schema":{"type":"boolean"},"description":"Filter the inquiries by completion status."},{"in":"query","required":false,"name":"page[after]","example":"df786f04a209","schema":{"type":"string"},"description":"Fetch inquiries after this cursor"},{"in":"query","required":false,"name":"page[before]","example":"5061496e","schema":{"type":"string"},"description":"Fetch inquiries before this cursor"},{"in":"query","required":false,"name":"page[size]","example":10,"schema":{"type":"integer","minimum":1,"maximum":200},"description":"The maximum number of inquiries to return"},{"in":"query","required":false,"name":"order","example":"asc","schema":{"type":"string","enum":["asc","desc"]},"description":"The order of the inquiries. Defaults to asc."},{"in":"query","required":false,"name":"sort","example":"createdAt","schema":{"type":"string","enum":["createdAt","updatedAt"]},"description":"The field to sort the inquiries by. Defaults to createdAt."}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"type":"object","title":"InquiriesResponse","properties":{"metadata":{"type":"object","properties":{"page":{"type":"object","properties":{"size":{"example":50,"type":"integer","description":"The maximum number of items to return."},"total":{"example":20,"type":"integer","description":"The number of items in the results set."},"after":{"example":"df786f04","type":"string","description":"The cursor to fetch the next page of inquiries."},"before":{"example":"0679c533","type":"string","description":"The cursor to fetch the previous page of inquiries."}}}}},"data":{"type":"array","title":"Inquiries","items":{"type":"object","title":"Inquiry","properties":{"id":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"},"ssn":{"type":"string","example":"01029413157","description":"The unique identifier for the person the inquiry is for."},"url":{"example":"https://informasjonsinnhenting.prod.neobits.ai?applicationState=ey12345","format":"uri","type":"string","description":"Give this URL to the user so they can start the flow."},"externalId":{"type":"string","example":"CAN_BE_ANY_STRING","description":"Optional identifier the consumer of the API can provide."},"skipConsentMessages":{"type":"boolean","example":true,"description":"Will skip messages explaining to the user which consents are needed to complete the flow."},"isCompleted":{"type":"boolean","example":false,"description":"Indicates if the inquiry is completed or not by the user."},"createdAt":{"type":"string","format":"date-time","example":"2019-09-07T15:50:00Z","description":"Inquiry created date"},"updatedAt":{"type":"string","format":"date-time","example":"2019-09-07T15:50:00Z","description":"Inquiry last updated date"},"notifications":{"type":"array","description":"The notification options set for the inquiry.","items":{"type":"object","title":"NotificationOptions","required":["type","message","to"],"properties":{"type":{"type":"string","enum":["SMS"],"example":"SMS"},"message":{"type":"string","example":"Hei. For å dele din informasjon med Bank Bankersen ASA, vennligst gå til denne lenken $link","description":"The consumer of the API can decide where to place the link to initate the process by passing in $link (see example)"},"to":{"type":"string","example":"12345678","description":"The phone number you want the text message to be sent to"}}}},"redirect":{"type":"object","title":"RedirectOptions","description":"URL's provided here will decide where the user should be sent on flow completion","properties":{"onSuccess":{"type":"string","description":"URL to send the user to after the data is fetched","format":"url","example":"https://your.frontend.com/success"},"onError":{"type":"string","description":"URL to send the user to when an error occurs. See the \"Error handling\" section above for more info.","format":"url","example":"https://your.frontend.com/error"}}},"metadata":{"type":"object","properties":{"sbl":{"type":"object","properties":{"authCode":{"type":"string","example":"0679c533-5061-496e-8dc5-df786f04a209","description":"Auhtorization code received from Altinn. Used to retrieve the customers data from Skatteetaten."}}}}},"prerequisites":{"type":"array","description":"Prerequisites are actions that the user must complete before the data can be fetched. They can either be consents that must be given, or flows that must be completed.","items":{"type":"object","title":"Prerequisite","description":"Prerequisites are actions that the user must complete before the data can be fetched. They can either be consents that must be given, or flows that must be completed.","properties":{"name":{"type":"string","enum":["SBL"],"example":"SBL"},"isCompleted":{"type":"boolean","description":"Whether the prerequisite has been completed or not. When the prerequisite requires the user to give prior consent, this field will be true if the user has given consent."},"consentUrl":{"type":["string","null"],"description":"The URL neobits will redirect the user to internally, so the user can complete the prerequisite.","format":"uri"}}}}}}}}}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"BadRequestResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["BadRequest"],"example":"BadRequest"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["400-000","400-001","400-002","400-003","400-004","400-005","400-006","400-007","400-008","400-100","400-101","400-102","400-103","400-104","400-105","400-106","400-107","400-108","400-109","400-110","400-111","400-112"],"example":"400-001"},"message":{"type":"string","example":"Field 'ssn' is required"}}}}}}}}},"401":{"description":"Unauthorized","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"UnauthorizedResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Unauthorized"],"example":"Unauthorized"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["401-000","401-001","401-002","401-003","401-004","401-005","401-006","401-007"],"example":"401-000"},"message":{"type":"string","example":"Client is not authenticated"}}}}}}}}},"403":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ForbiddenResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Forbidden"],"example":"Forbidden"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["403-000","403-001"],"example":"403-000"},"message":{"type":"string","example":"Client does not have access to this resource"}}}}}}}}},"404":{"description":"Not Found","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"NotFoundResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["NotFound"],"example":"NotFound"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["404-000","404-001","404-002"],"example":"404-000"},"message":{"type":"string","example":"The requested resource was not found"}}}}}}}}},"429":{"description":"Too Many Requests. When the rate limit rejects a request, the response carries `Retry-After` and only the `errors` field: no `timestamp`, `moreInfo` or `X-Request-ID`, as the request never reached the API.","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"Retry-After":{"description":"Seconds to wait before retrying. Sent when the rate limit rejects a request.","schema":{"type":"integer","example":60}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TooManyRequestsResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["TooManyRequests"],"example":"TooManyRequests"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["429-000"],"example":"429-000"},"message":{"type":"string","example":"Too many requests. Please try again later."}}}}}}}}},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"InternalServerErrorResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["InternalServerError"],"example":"InternalServerError"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["500-000","500-001"],"example":"500-000"},"message":{"type":"string","example":"An unexpected internal error occurred"}}}}}}}}},"503":{"description":"Service Unavailable","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ServiceUnavailableResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["ServiceUnavailable"],"example":"ServiceUnavailable"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["503-000"],"example":"503-000"},"message":{"type":"string","example":"An error occurred while interacting with a third party service"}}}}}}}}},"504":{"description":"Gateway Timeout","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TimeoutResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["GatewayTimeout"],"example":"GatewayTimeout"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["504-000"],"example":"504-000"},"message":{"type":"string","example":"The request timed out"}}}}}}}}}}}},"/fuse/v2/inquiries/{inquiryId}":{"delete":{"operationId":"inquiry-delete","tags":["Fuse"],"summary":"Delete an inquiry (TBA)","description":"
❗

Authorization Required

This endpoint requires authentication via the Core API Auth server.
Learn about authentication →
\n
\n
Inquiries that are completed cannot be deleted.
","security":[{"basic":[]}],"parameters":[{"in":"path","name":"inquiryId","required":true,"example":"0679c533-5061-496e-8dc5-df786f04a209","schema":{"type":"string"},"description":"The unique identifier of the inquiry"}],"responses":{"204":{"description":"No Content","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"BadRequestResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["BadRequest"],"example":"BadRequest"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["400-000","400-001","400-002","400-003","400-004","400-005","400-006","400-007","400-008","400-100","400-101","400-102","400-103","400-104","400-105","400-106","400-107","400-108","400-109","400-110","400-111","400-112"],"example":"400-001"},"message":{"type":"string","example":"Field 'ssn' is required"}}}}}}}}},"401":{"description":"Unauthorized","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"UnauthorizedResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Unauthorized"],"example":"Unauthorized"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["401-000","401-001","401-002","401-003","401-004","401-005","401-006","401-007"],"example":"401-000"},"message":{"type":"string","example":"Client is not authenticated"}}}}}}}}},"403":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ForbiddenResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Forbidden"],"example":"Forbidden"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["403-000","403-001"],"example":"403-000"},"message":{"type":"string","example":"Client does not have access to this resource"}}}}}}}}},"404":{"description":"Not Found","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"NotFoundResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["NotFound"],"example":"NotFound"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["404-000","404-001","404-002"],"example":"404-000"},"message":{"type":"string","example":"The requested resource was not found"}}}}}}}}},"429":{"description":"Too Many Requests. When the rate limit rejects a request, the response carries `Retry-After` and only the `errors` field: no `timestamp`, `moreInfo` or `X-Request-ID`, as the request never reached the API.","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"Retry-After":{"description":"Seconds to wait before retrying. Sent when the rate limit rejects a request.","schema":{"type":"integer","example":60}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TooManyRequestsResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["TooManyRequests"],"example":"TooManyRequests"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["429-000"],"example":"429-000"},"message":{"type":"string","example":"Too many requests. Please try again later."}}}}}}}}},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"InternalServerErrorResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["InternalServerError"],"example":"InternalServerError"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["500-000","500-001"],"example":"500-000"},"message":{"type":"string","example":"An unexpected internal error occurred"}}}}}}}}},"503":{"description":"Service Unavailable","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ServiceUnavailableResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["ServiceUnavailable"],"example":"ServiceUnavailable"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["503-000"],"example":"503-000"},"message":{"type":"string","example":"An error occurred while interacting with a third party service"}}}}}}}}},"504":{"description":"Gateway Timeout","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TimeoutResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["GatewayTimeout"],"example":"GatewayTimeout"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["504-000"],"example":"504-000"},"message":{"type":"string","example":"The request timed out"}}}}}}}}}}},"patch":{"operationId":"inquiry-patch","tags":["Fuse"],"summary":"Update an inquiry (TBA)","description":"
❗

Authorization Required

This endpoint requires authentication via the Core API Auth server.

Learn about authentication →
\n
\n
Partially update an inquiry.
","security":[{"basic":[]}],"parameters":[{"in":"path","name":"inquiryId","required":true,"example":"0679c533-5061-496e-8dc5-df786f04a209","schema":{"type":"string"},"description":"The unique identifier of the inquiry"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"PatchInquiryRequestBody","type":"object","properties":{"externalId":{"type":"string","example":"CAN_BE_ANY_STRING","description":"Optional identifier the consumer of the API can provide."},"skipConsentMessages":{"type":"boolean","example":true,"description":"Will skip messages explaining to the user which consents are needed to complete the flow."},"notifications":{"type":"array","description":"The notification array allows the consumer of the API to trigger text message and emails to alert the customer","items":{"type":"object","title":"NotificationOptions","required":["type","message","to"],"properties":{"type":{"type":"string","enum":["SMS"],"example":"SMS"},"message":{"type":"string","example":"Hei. For å dele din informasjon med Bank Bankersen ASA, vennligst gå til denne lenken $link","description":"The consumer of the API can decide where to place the link to initate the process by passing in $link (see example)"},"to":{"type":"string","example":"12345678","description":"The phone number you want the text message to be sent to"}}}},"redirect":{"type":"object","title":"RedirectOptions","description":"URL's provided here will decide where the user should be sent on flow completion","properties":{"onSuccess":{"type":"string","description":"URL to send the user to after the data is fetched","format":"url","example":"https://your.frontend.com/success"},"onError":{"type":"string","description":"URL to send the user to when an error occurs. See the \"Error handling\" section above for more info.","format":"url","example":"https://your.frontend.com/error"}}}}}}}},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"type":"object","title":"Inquiry","properties":{"id":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"},"ssn":{"type":"string","example":"01029413157","description":"The unique identifier for the person the inquiry is for."},"url":{"example":"https://informasjonsinnhenting.prod.neobits.ai?applicationState=ey12345","format":"uri","type":"string","description":"Give this URL to the user so they can start the flow."},"externalId":{"type":"string","example":"CAN_BE_ANY_STRING","description":"Optional identifier the consumer of the API can provide."},"skipConsentMessages":{"type":"boolean","example":true,"description":"Will skip messages explaining to the user which consents are needed to complete the flow."},"isCompleted":{"type":"boolean","example":false,"description":"Indicates if the inquiry is completed or not by the user."},"createdAt":{"type":"string","format":"date-time","example":"2019-09-07T15:50:00Z","description":"Inquiry created date"},"updatedAt":{"type":"string","format":"date-time","example":"2019-09-07T15:50:00Z","description":"Inquiry last updated date"},"notifications":{"type":"array","description":"The notification options set for the inquiry.","items":{"type":"object","title":"NotificationOptions","required":["type","message","to"],"properties":{"type":{"type":"string","enum":["SMS"],"example":"SMS"},"message":{"type":"string","example":"Hei. For å dele din informasjon med Bank Bankersen ASA, vennligst gå til denne lenken $link","description":"The consumer of the API can decide where to place the link to initate the process by passing in $link (see example)"},"to":{"type":"string","example":"12345678","description":"The phone number you want the text message to be sent to"}}}},"redirect":{"type":"object","title":"RedirectOptions","description":"URL's provided here will decide where the user should be sent on flow completion","properties":{"onSuccess":{"type":"string","description":"URL to send the user to after the data is fetched","format":"url","example":"https://your.frontend.com/success"},"onError":{"type":"string","description":"URL to send the user to when an error occurs. See the \"Error handling\" section above for more info.","format":"url","example":"https://your.frontend.com/error"}}},"metadata":{"type":"object","properties":{"sbl":{"type":"object","properties":{"authCode":{"type":"string","example":"0679c533-5061-496e-8dc5-df786f04a209","description":"Auhtorization code received from Altinn. Used to retrieve the customers data from Skatteetaten."}}}}},"prerequisites":{"type":"array","description":"Prerequisites are actions that the user must complete before the data can be fetched. They can either be consents that must be given, or flows that must be completed.","items":{"type":"object","title":"Prerequisite","description":"Prerequisites are actions that the user must complete before the data can be fetched. They can either be consents that must be given, or flows that must be completed.","properties":{"name":{"type":"string","enum":["SBL"],"example":"SBL"},"isCompleted":{"type":"boolean","description":"Whether the prerequisite has been completed or not. When the prerequisite requires the user to give prior consent, this field will be true if the user has given consent."},"consentUrl":{"type":["string","null"],"description":"The URL neobits will redirect the user to internally, so the user can complete the prerequisite.","format":"uri"}}}}}}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"BadRequestResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["BadRequest"],"example":"BadRequest"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["400-000","400-001","400-002","400-003","400-004","400-005","400-006","400-007","400-008","400-100","400-101","400-102","400-103","400-104","400-105","400-106","400-107","400-108","400-109","400-110","400-111","400-112"],"example":"400-001"},"message":{"type":"string","example":"Field 'ssn' is required"}}}}}}}}},"401":{"description":"Unauthorized","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"UnauthorizedResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Unauthorized"],"example":"Unauthorized"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["401-000","401-001","401-002","401-003","401-004","401-005","401-006","401-007"],"example":"401-000"},"message":{"type":"string","example":"Client is not authenticated"}}}}}}}}},"403":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ForbiddenResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Forbidden"],"example":"Forbidden"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["403-000","403-001"],"example":"403-000"},"message":{"type":"string","example":"Client does not have access to this resource"}}}}}}}}},"404":{"description":"Not Found","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"NotFoundResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["NotFound"],"example":"NotFound"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["404-000","404-001","404-002"],"example":"404-000"},"message":{"type":"string","example":"The requested resource was not found"}}}}}}}}},"429":{"description":"Too Many Requests. When the rate limit rejects a request, the response carries `Retry-After` and only the `errors` field: no `timestamp`, `moreInfo` or `X-Request-ID`, as the request never reached the API.","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"Retry-After":{"description":"Seconds to wait before retrying. Sent when the rate limit rejects a request.","schema":{"type":"integer","example":60}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TooManyRequestsResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["TooManyRequests"],"example":"TooManyRequests"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["429-000"],"example":"429-000"},"message":{"type":"string","example":"Too many requests. Please try again later."}}}}}}}}},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"InternalServerErrorResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["InternalServerError"],"example":"InternalServerError"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["500-000","500-001"],"example":"500-000"},"message":{"type":"string","example":"An unexpected internal error occurred"}}}}}}}}},"503":{"description":"Service Unavailable","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ServiceUnavailableResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["ServiceUnavailable"],"example":"ServiceUnavailable"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["503-000"],"example":"503-000"},"message":{"type":"string","example":"An error occurred while interacting with a third party service"}}}}}}}}},"504":{"description":"Gateway Timeout","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TimeoutResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["GatewayTimeout"],"example":"GatewayTimeout"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["504-000"],"example":"504-000"},"message":{"type":"string","example":"The request timed out"}}}}}}}}}}},"get":{"operationId":"inquiry","tags":["Fuse"],"summary":"Get an inquiry","description":"
❗

Authorization Required

This endpoint requires authentication via the Core API Auth server.
Learn about authentication →
\n
\n
Fetch a single inquiry using its id.
","security":[{"basic":[]}],"parameters":[{"in":"path","name":"inquiryId","required":true,"example":"0679c533-5061-496e-8dc5-df786f04a209","schema":{"type":"string"},"description":"The unique identifier of the inquiry"}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"type":"object","title":"Inquiry","properties":{"id":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"},"ssn":{"type":"string","example":"01029413157","description":"The unique identifier for the person the inquiry is for."},"url":{"example":"https://informasjonsinnhenting.prod.neobits.ai?applicationState=ey12345","format":"uri","type":"string","description":"Give this URL to the user so they can start the flow."},"externalId":{"type":"string","example":"CAN_BE_ANY_STRING","description":"Optional identifier the consumer of the API can provide."},"skipConsentMessages":{"type":"boolean","example":true,"description":"Will skip messages explaining to the user which consents are needed to complete the flow."},"isCompleted":{"type":"boolean","example":false,"description":"Indicates if the inquiry is completed or not by the user."},"createdAt":{"type":"string","format":"date-time","example":"2019-09-07T15:50:00Z","description":"Inquiry created date"},"updatedAt":{"type":"string","format":"date-time","example":"2019-09-07T15:50:00Z","description":"Inquiry last updated date"},"notifications":{"type":"array","description":"The notification options set for the inquiry.","items":{"type":"object","title":"NotificationOptions","required":["type","message","to"],"properties":{"type":{"type":"string","enum":["SMS"],"example":"SMS"},"message":{"type":"string","example":"Hei. For å dele din informasjon med Bank Bankersen ASA, vennligst gå til denne lenken $link","description":"The consumer of the API can decide where to place the link to initate the process by passing in $link (see example)"},"to":{"type":"string","example":"12345678","description":"The phone number you want the text message to be sent to"}}}},"redirect":{"type":"object","title":"RedirectOptions","description":"URL's provided here will decide where the user should be sent on flow completion","properties":{"onSuccess":{"type":"string","description":"URL to send the user to after the data is fetched","format":"url","example":"https://your.frontend.com/success"},"onError":{"type":"string","description":"URL to send the user to when an error occurs. See the \"Error handling\" section above for more info.","format":"url","example":"https://your.frontend.com/error"}}},"metadata":{"type":"object","properties":{"sbl":{"type":"object","properties":{"authCode":{"type":"string","example":"0679c533-5061-496e-8dc5-df786f04a209","description":"Auhtorization code received from Altinn. Used to retrieve the customers data from Skatteetaten."}}}}},"prerequisites":{"type":"array","description":"Prerequisites are actions that the user must complete before the data can be fetched. They can either be consents that must be given, or flows that must be completed.","items":{"type":"object","title":"Prerequisite","description":"Prerequisites are actions that the user must complete before the data can be fetched. They can either be consents that must be given, or flows that must be completed.","properties":{"name":{"type":"string","enum":["SBL"],"example":"SBL"},"isCompleted":{"type":"boolean","description":"Whether the prerequisite has been completed or not. When the prerequisite requires the user to give prior consent, this field will be true if the user has given consent."},"consentUrl":{"type":["string","null"],"description":"The URL neobits will redirect the user to internally, so the user can complete the prerequisite.","format":"uri"}}}}}}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"BadRequestResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["BadRequest"],"example":"BadRequest"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["400-000","400-001","400-002","400-003","400-004","400-005","400-006","400-007","400-008","400-100","400-101","400-102","400-103","400-104","400-105","400-106","400-107","400-108","400-109","400-110","400-111","400-112"],"example":"400-001"},"message":{"type":"string","example":"Field 'ssn' is required"}}}}}}}}},"401":{"description":"Unauthorized","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"UnauthorizedResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Unauthorized"],"example":"Unauthorized"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["401-000","401-001","401-002","401-003","401-004","401-005","401-006","401-007"],"example":"401-000"},"message":{"type":"string","example":"Client is not authenticated"}}}}}}}}},"403":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ForbiddenResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Forbidden"],"example":"Forbidden"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["403-000","403-001"],"example":"403-000"},"message":{"type":"string","example":"Client does not have access to this resource"}}}}}}}}},"404":{"description":"Not Found","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"NotFoundResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["NotFound"],"example":"NotFound"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["404-000","404-001","404-002"],"example":"404-000"},"message":{"type":"string","example":"The requested resource was not found"}}}}}}}}},"429":{"description":"Too Many Requests. When the rate limit rejects a request, the response carries `Retry-After` and only the `errors` field: no `timestamp`, `moreInfo` or `X-Request-ID`, as the request never reached the API.","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"Retry-After":{"description":"Seconds to wait before retrying. Sent when the rate limit rejects a request.","schema":{"type":"integer","example":60}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TooManyRequestsResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["TooManyRequests"],"example":"TooManyRequests"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["429-000"],"example":"429-000"},"message":{"type":"string","example":"Too many requests. Please try again later."}}}}}}}}},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"InternalServerErrorResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["InternalServerError"],"example":"InternalServerError"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["500-000","500-001"],"example":"500-000"},"message":{"type":"string","example":"An unexpected internal error occurred"}}}}}}}}},"503":{"description":"Service Unavailable","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ServiceUnavailableResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["ServiceUnavailable"],"example":"ServiceUnavailable"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["503-000"],"example":"503-000"},"message":{"type":"string","example":"An error occurred while interacting with a third party service"}}}}}}}}},"504":{"description":"Gateway Timeout","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TimeoutResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["GatewayTimeout"],"example":"GatewayTimeout"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["504-000"],"example":"504-000"},"message":{"type":"string","example":"The request timed out"}}}}}}}}}}}},"/fuse/v2/persons/{ssn}":{"get":{"operationId":"person","tags":["Fuse"],"summary":"Get a person","security":[{"basic":[]}],"description":"
\n
\n ❗\n
\n #### Authorization Required\n
\n
\n
\n

This endpoint requires authentication via the Core API Auth server.

\n Learn about authentication →\n
\n
\n\n
\n\nUse this endpoint to fetch information about a customer. If the data in question\nrequires prior consent from the customer,\nthen you need to create an inquiry first and give the inquiry url to your customer,\nso that they can consent to share their data.\n\n
\n\nWhen the inquiry is completed by the customer, you can come back and use the inquiryId\nto fetch data.\n","parameters":[{"in":"path","name":"ssn","required":true,"example":"01029413157","schema":{"type":"string"},"description":"The unique identifier for the person"},{"in":"query","name":"inquiryId","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"},"required":false,"description":"If the data you are fetching requires an inquiry to be created and completed by the customer first, then this parameter is required."}],"responses":{"200":{"headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"title":"PersonWithConsent","type":"object","description":"Returns data for a person where the users consent is required and is completed via \"Initate\". Requires the \"code\" query param passed as part of the request.","properties":{"ssn":{"type":"string","example":"01029413157"},"firstName":{"type":"string","example":"STOR"},"lastName":{"type":"string","example":"MÅNE"},"maritalStatus":{"type":"string","enum":["MARRIED","NOT_GIVEN","UNMARRIED","DIVORCED","SEPARATED","WIDOW_ER","REGISTERED_PARTNER","SEPARATED_PARTNER","DIVORCED_PARTNER","REMAINING_PARTNER"]},"citizenships":{"type":"array","items":{"title":"Citizenship","type":"object","properties":{"citizenship":{"type":"string","example":"NOR"},"isApplicable":{"type":"boolean","example":true,"description":"maps to 'erGjeldende' in the original response"}}}},"gender":{"type":"string","example":"MALE","enum":["MALE","FEMALE","UNKNOWN"]},"birthdate":{"type":"string","format":"date","example":"1982-02-21"},"countryOfBirth":{"type":"string","example":"NOR"},"status":{"type":"string","example":"RESIDENT","description":"The current status of the person in the Norwegian Population Registry","enum":["RESIDENT","RELOCATED","DISAPPEARED","DISEASED","CEASED","REGISTERED_BY_BIRTH","TEMPORARY","INACTIVE","NON_RESIDENT","ACTIVE","UNKNOWN"]},"employmentStatus":{"type":"string","description":"Inferred from the applicants income report of the last month.","enum":["PERMANENTLY_EMPLOYED","TEMPORARILY_EMPLOYED","SICKNESS_ALLOWANCE","DISABILITY_PENSION","RETIRED","UNEMPLOYED","OTHER"],"example":"PERMANENTLY_EMPLOYED"},"receivesSocialSecurityBenefits":{"type":"boolean","example":true,"description":"Inferred from the applicants income report of the last month."},"hasAttachmentCharge":{"type":"boolean","example":true,"description":"Searches through the movables registry (løsøre) to find active attachment charges (UTLEGG/UTPANTING)."},"residentialAddress":{"type":["object","null"],"title":"ResidentialAddress","description":"The persons Norwegian residential address. May be null, if the person is living in a foreign country.","properties":{"updatedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"street":{"type":"object","properties":{"name":{"type":"string","example":"Rudvegen"},"number":{"type":"string","example":"57"},"letter":{"type":["string","null"],"example":"A"}}},"municipality":{"type":"object","properties":{"name":{"type":"string","example":"NESBYEN"},"number":{"type":"string","example":"3540"}}}}},"family":{"type":"object","properties":{"numChildrenBelowAge18":{"type":"integer","description":"Number of persons in the family that are below 18 years of age"},"members":{"type":"array","items":{"type":"object","properties":{"ssn":{"type":"string","example":"03028711300","description":"11 digit identification number of the person."},"age":{"type":"integer","example":34},"gender":{"type":"string","enum":["FEMALE","MALE"]},"relation":{"type":"string","enum":["PARENT","SPOUSE_OR_PARTNER","CHILD","SIBLING"],"description":"The persons relation to the family member."}}}}}},"property":{"type":"object","title":"PropertyOverview","description":"Aggregation of Kartverket API and Eiendomsverdi API","properties":{"ownsProperty":{"type":"boolean","example":true},"properties":{"type":"array","items":{"type":"object","title":"Property","discriminator":{"propertyName":"type","mapping":{"SelfOwnedProperty":"./SelfOwnedProperty.yaml","HousingCooperative":"./HousingCooperative.yaml"}},"anyOf":[{"type":"object","title":"SelfOwnedProperty","properties":{"id":{"type":"string","example":"039456312"},"type":{"type":"string","enum":["SELF_OWNED","HOUSING_COOPERATIVE"],"example":"SELF_OWNED"},"value":{"type":"number","format":"double","example":5000000},"valueEstimate":{"type":"number","format":"double","example":5000000},"valueEstimateHaircut":{"type":"number","format":"double","example":5000000},"commonDebt":{"type":"number","format":"double","example":5000000},"netValueEstimate":{"type":"number","format":"double","example":2000000},"grossValueEstimate":{"type":"number","format":"double","example":2000000},"areaMarketScore":{"type":"integer","example":20,"minimum":1,"maximum":20},"municipalityScore":{"type":"integer","example":20,"minimum":1,"maximum":20},"customerApprovedValue":{"type":"integer","example":20},"valueEstimateAccuracyLevel":{"type":"number","format":"double","example":4},"purchasedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"cadastralUnitNumber":{"type":["string","null"],"example":"7"},"propertyUnitNumber":{"type":["string","null"],"example":"391"},"leaseholdNumber":{"type":["string","null"],"example":"0"},"condominiumUnitNumber":{"type":["string","null"],"example":"0"},"ownershipShare":{"type":"number","example":0.5},"estateType":{"type":"string","enum":["APARTMENT","DETACHED_HOUSE","TERRACED_HOUSE","SEMI_DETACHED_HOUSE","LEISURE_HOME","DORM","RESIDENTIAL_PLOT","CABIN_PLOT","SCHOOL_KINDERGARTEN","COMMERCIAL_BUILDING","FARM","HOUSING","HOUSE","SHARED_HOUSING","GARAGE","UNDEVELOPED","PUBLIC","HEALTH","MEDIA_COMM","CULTURE_AND_SPORTS","RELIGION","TRANSPORTATION","OTHER","UNKNOWN"],"example":"DETACHED_HOUSE"},"street":{"title":"Street","type":"object","properties":{"name":{"type":["string","null"],"example":"Smedstusvingen"},"number":{"type":["string","null"],"example":"18"},"letter":{"type":["string","null"],"example":"A"}}},"zip":{"title":"Zip","type":"object","properties":{"code":{"type":["string","null"],"example":"1480"},"area":{"type":["string","null"],"example":"SLATTUM"}}},"municipality":{"title":"Municipality","type":"object","properties":{"number":{"type":["string","null"],"example":"3031"},"area":{"type":["string","null"],"example":"NITTEDAL"}}},"liens":{"type":"array","items":{"title":"Lien","type":"object","properties":{"id":{"type":"string","example":"039456312"},"updatedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"creditorName":{"type":"string","example":"SPAREBANKEN TELEMARK"},"creditorOrgNumber":{"type":"string","example":"985621551"},"value":{"type":"number","example":4500000}}}}}},{"type":"object","title":"HousingCooperative","properties":{"id":{"type":"string","example":"039456312"},"type":{"type":"string","enum":["SELF_OWNED","HOUSING_COOPERATIVE"],"example":"SELF_OWNED"},"value":{"type":"number","format":"double","example":5000000},"valueEstimate":{"type":"number","format":"double","example":5000000},"valueEstimateHaircut":{"type":"number","format":"double","example":5000000},"commonDebt":{"type":"number","format":"double","example":5000000},"netValueEstimate":{"type":"number","format":"double","example":2000000},"grossValueEstimate":{"type":"number","format":"double","example":2000000},"areaMarketScore":{"type":"integer","example":20,"minimum":1,"maximum":20},"municipalityScore":{"type":"integer","example":20,"minimum":1,"maximum":20},"customerApprovedValue":{"type":"integer","example":20},"valueEstimateAccuracyLevel":{"type":"number","format":"double","example":4},"purchasedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"cadastralUnitNumber":{"type":["string","null"],"example":"7"},"propertyUnitNumber":{"type":["string","null"],"example":"391"},"leaseholdNumber":{"type":["string","null"],"example":"0"},"condominiumUnitNumber":{"type":["string","null"],"example":"0"},"ownershipShare":{"type":"number","example":0.5},"estateType":{"type":"string","enum":["APARTMENT","DETACHED_HOUSE","TERRACED_HOUSE","SEMI_DETACHED_HOUSE","LEISURE_HOME","DORM","RESIDENTIAL_PLOT","CABIN_PLOT","SCHOOL_KINDERGARTEN","COMMERCIAL_BUILDING","FARM","HOUSING","HOUSE","SHARED_HOUSING","GARAGE","UNDEVELOPED","PUBLIC","HEALTH","MEDIA_COMM","CULTURE_AND_SPORTS","RELIGION","TRANSPORTATION","OTHER","UNKNOWN"],"example":"DETACHED_HOUSE"},"street":{"title":"Street","type":"object","properties":{"name":{"type":["string","null"],"example":"Smedstusvingen"},"number":{"type":["string","null"],"example":"18"},"letter":{"type":["string","null"],"example":"A"}}},"zip":{"title":"Zip","type":"object","properties":{"code":{"type":["string","null"],"example":"1480"},"area":{"type":["string","null"],"example":"SLATTUM"}}},"municipality":{"title":"Municipality","type":"object","properties":{"number":{"type":["string","null"],"example":"3031"},"area":{"type":["string","null"],"example":"NITTEDAL"}}},"housingCooperative":{"title":"HousingCooperativeInformation","type":"object","properties":{"id":{"type":"string","example":"5424543"},"name":{"type":"string","example":"TERTITTEN BORETTSLAG"},"orgID":{"type":"string","example":"12345678911"},"shareNumber":{"type":"string","example":25}}},"liens":{"type":"array","items":{"title":"Lien","type":"object","properties":{"id":{"type":"string","example":"039456312"},"updatedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"creditorName":{"type":"string","example":"SPAREBANKEN TELEMARK"},"creditorOrgNumber":{"type":"string","example":"985621551"},"value":{"type":"number","example":4500000}}}}}}]}}}},"debt":{"type":"object","properties":{"sumEstimatedBalance":{"type":"number","format":"double","example":40000000},"sumOriginalBalance":{"type":"number","format":"double","example":60000000},"sumAccruedInterestFromDebtCollectors":{"type":"number","format":"double","example":400},"sumOwedMaintenancePayments":{"type":"number","format":"double","example":15000},"sumOwedUnderpaidTax":{"type":"number","format":"double","example":4000},"sumLatePaymentInterest":{"type":"number","format":"double","example":346},"mortgageDebt":{"title":"MortgageDebtOverview","type":"object","properties":{"sumEstimatedBalance":{"type":"number","format":"double","example":40000000},"sumOriginalBalance":{"type":"number","format":"double","example":60000000},"sumEstimatedBalanceByOwnership":{"type":"number","format":"double","example":35000000},"sumOriginalBalanceByOwnership":{"type":"number","format":"double","example":50000000},"debts":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"creditorName":{"type":"string","example":"CREDITOR NAME"},"estimatedBalance":{"type":"number","format":"double","example":4107055.83,"description":"An estimate of what the balance might be today."},"originalBalance":{"type":"number","format":"double","example":4407055.83,"description":"The balance gathered from the data source."},"updatedAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Updated date in the source registry."},"createdAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Created date in the source registry."},"estimatedDuration":{"type":"number","example":260,"description":"Specifies the estimated duration in months used in the amortization calculations"},"estimatedRemainingDuration":{"type":"number","example":180,"description":"Specifies the estimated remaining duration in months of the loan"},"estimatedNominalInterestRate":{"type":"number","example":13.4,"format":"double","description":"Specifies the estimated nominal interest rate used in the amortization calculations"},"estimatedMonthlyPayment":{"type":"number","example":2980.45,"format":"double","description":"Specifies the estimated monthly downpayment as a result of the amortization calculations"}}},{"type":"object","properties":{"propertyOwnershipShare":{"type":"number","format":"double","example":0.5,"description":"The ownership share of the property in the mortgage."},"originalBalanceByOwnership":{"type":"number","format":"double","example":3000000,"description":"The original balance multiplied by the property ownership share."},"estimatedBalanceByOwnership":{"type":"number","format":"double","example":2000000,"description":"The estimated balance multiplied by the property ownership share."},"adjustedOriginalBalance":{"type":"number","format":"double","example":50000000,"description":"The assumed actual original balance of the mortgage."},"balanceSource":{"type":"string","enum":["SKATTEETATEN","KARTVERKET"],"example":"KARTVERKET","description":"Specifies which source the originalBalance and estimatedBalance come from."},"lienId":{"type":["string","null"],"example":"288863652"},"propertyId":{"type":["string","null"],"example":"3713739"}}}]}}}},"studentDebt":{"title":"StudentDebtOverview","type":"object","properties":{"sumEstimatedBalance":{"type":"number","format":"double","example":40000000},"sumOriginalBalance":{"type":"number","format":"double","example":60000000},"debts":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"creditorName":{"type":"string","example":"CREDITOR NAME"},"estimatedBalance":{"type":"number","format":"double","example":4107055.83,"description":"An estimate of what the balance might be today."},"originalBalance":{"type":"number","format":"double","example":4407055.83,"description":"The balance gathered from the data source."},"updatedAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Updated date in the source registry."},"createdAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Created date in the source registry."},"estimatedDuration":{"type":"number","example":260,"description":"Specifies the estimated duration in months used in the amortization calculations"},"estimatedRemainingDuration":{"type":"number","example":180,"description":"Specifies the estimated remaining duration in months of the loan"},"estimatedNominalInterestRate":{"type":"number","example":13.4,"format":"double","description":"Specifies the estimated nominal interest rate used in the amortization calculations"},"estimatedMonthlyPayment":{"type":"number","example":2980.45,"format":"double","description":"Specifies the estimated monthly downpayment as a result of the amortization calculations"}}},{"type":"object","properties":{"balanceSource":{"type":"string","enum":["SKATTEETATEN"],"example":"SKATTEETATEN","description":"Specifies which source the originalBalance and estimatedBalance come from."}}}]}}}},"autoDebt":{"title":"AutoDebtOverview","type":"object","properties":{"sumEstimatedBalance":{"type":"number","format":"double","example":40000000},"sumOriginalBalance":{"type":"number","format":"double","example":60000000},"debts":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"creditorName":{"type":"string","example":"CREDITOR NAME"},"estimatedBalance":{"type":"number","format":"double","example":4107055.83,"description":"An estimate of what the balance might be today."},"originalBalance":{"type":"number","format":"double","example":4407055.83,"description":"The balance gathered from the data source."},"updatedAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Updated date in the source registry."},"createdAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Created date in the source registry."},"estimatedDuration":{"type":"number","example":260,"description":"Specifies the estimated duration in months used in the amortization calculations"},"estimatedRemainingDuration":{"type":"number","example":180,"description":"Specifies the estimated remaining duration in months of the loan"},"estimatedNominalInterestRate":{"type":"number","example":13.4,"format":"double","description":"Specifies the estimated nominal interest rate used in the amortization calculations"},"estimatedMonthlyPayment":{"type":"number","example":2980.45,"format":"double","description":"Specifies the estimated monthly downpayment as a result of the amortization calculations"}}},{"type":"object","properties":{"registrationNumber":{"type":"string","example":"BP22352","description":"The registration number of the vehicle."},"balanceSource":{"type":"string","enum":["SKATTEETATEN","LOSOREREGISTERET"],"example":"LOSOREREGISTERET","description":"Specifies which source the originalBalance and estimatedBalance come from."}}}]}}}},"unsecuredDebt":{"title":"UnsecuredDebtOverview","type":"object","properties":{"sumBalance":{"type":"number","format":"double","example":40000000},"sumOriginalBalance":{"type":"number","format":"double","example":60000000},"sumCreditLimit":{"type":"number","format":"double","example":60000000},"debts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"CREDIT_FACILITY","enum":["CREDIT_FACILITY","CHARGE_CARD","REPAYMENT_LOAN"]},"createdAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Created date in the source registry."},"updatedAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Created date in the source registry."},"creditorOrgNumber":{"type":"string","example":"983521592","description":"Organization number of the creditor"},"creditorName":{"type":"string","example":"SANTANDER CONSUMER BANK AS","description":"Name of the creditor"},"coBorrower":{"type":"string","enum":["HAS_CO_BORROWER","NO_CO_BORROWER","IS_CO_BORROWER"],"example":"HAS_CO_BORROWER","description":"Specifies the coborrower status. HAS_CO_BORROWER means the loan has a co-borrower, NO_CO_BORROWER means there are no co-borrowers, IS_CO_BORROWER means the applicant is a co-borrower of this loan."},"balance":{"type":"number","example":400000,"description":"Outstanding balance of the loan."},"originalBalance":{"type":"number","example":400000,"description":"Applies only to type REPAYMENT_LOAN"},"creditLimit":{"type":"number","example":30000,"description":"Applies only to type CREDIT_FACILITY"},"installmentCharges":{"type":"number","example":40},"installmentChargePeriod":{"type":"string","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"example":"MONTHLY"},"interestBearingBalance":{"type":"number","example":55000},"nonInterestBearingBalance":{"type":"number","example":20000},"nomInterestRate":{"type":"number","format":"double","example":12.3},"paymentsPerYear":{"type":"number","example":12},"duration":{"type":"number","example":12,"description":"Applies only to type REPAYMENT_LOAN"}}}}}}}},"income":{"type":"object","title":"IncomeOverview","properties":{"yearlyGrossIncome":{"type":"number","format":"double","example":1010000},"yearlyNetIncome":{"type":"number","format":"double","example":650000},"yearlyDrivingAllowance":{"type":"number","format":"double","example":650000},"yearlyBonus":{"type":"number","format":"double","example":650000},"yearlySalary":{"type":"number","format":"double","example":650000},"yearlyWage":{"type":"number","format":"double","example":650000},"yearlySicknessAllowance":{"type":"number","format":"double","example":650000},"yearlyDisabilityPension":{"type":"number","format":"double","example":650000},"yearlyPension":{"type":"number","format":"double","example":650000},"yearlyUnemploymentBenefit":{"type":"number","format":"double","example":650000},"yearlyWorkAssessmentAllowance":{"type":"number","format":"double","example":650000},"monthlyIncomeRecords":{"type":"array","items":{"title":"MonthlyIncomeRecord","type":"object","properties":{"grossIncome":{"type":"number","format":"double"},"netIncome":{"type":"number","format":"double"},"date":{"type":"string","format":"YYYY-MM"}}},"example":[{"grossIncome":30000,"netIncome":30000,"date":"2019-02"},{"grossIncome":30000,"netIncome":30000,"date":"2019-03"},{"grossIncome":30000,"netIncome":30000,"date":"2019-04"},{"grossIncome":30000,"netIncome":30000,"date":"2019-05"},{"grossIncome":30000,"netIncome":30000,"date":"2019-06"},{"grossIncome":30000,"netIncome":30000,"date":"2019-07"}]},"taxRecords":{"type":"array","description":"Sorted by key \"taxYear\" in descending order","items":{"title":"TaxRecord","type":"object","properties":{"taxYear":{"type":"string","example":"2018"},"yearlyGrossIncome":{"type":"number","format":"double","example":936618},"yearlySalary":{"type":"number","format":"double","example":936616},"yearlyRentalIncome":{"type":"number","format":"double","example":10000},"yearlyEstimatedTax":{"type":"number","format":"double","example":273562.23},"yearlyEstimatedNetIncome":{"type":"number","format":"double","example":663055.77},"employers":{"type":"array","items":{"title":"Employer","type":"object","properties":{"name":{"type":"string","example":"Min Jobb AS"},"orgID":{"type":["string","null"],"example":"123456789"}}}}}}}}}}},{"title":"PersonWithoutConsent","type":"object","description":"Returns data for a person where consent is not a requirement.","properties":{"ssn":{"type":"string","example":"01029413157"},"firstName":{"type":"string","example":"STOR"},"lastName":{"type":"string","example":"MÅNE"},"maritalStatus":{"type":"string","enum":["MARRIED","NOT_GIVEN","UNMARRIED","DIVORCED","SEPARATED","WIDOW_ER","REGISTERED_PARTNER","SEPARATED_PARTNER","DIVORCED_PARTNER","REMAINING_PARTNER"]},"citizenships":{"type":"array","items":{"title":"Citizenship","type":"object","properties":{"citizenship":{"type":"string","example":"NOR"},"isApplicable":{"type":"boolean","example":true,"description":"maps to 'erGjeldende' in the original response"}}}},"gender":{"type":"string","example":"MALE","enum":["MALE","FEMALE","UNKNOWN"]},"birthdate":{"type":"string","format":"YYYY-MM-DD","example":"1982-02-21"},"countryOfBirth":{"type":"string","example":"NOR"},"status":{"type":"string","example":"RESIDENT","description":"The current status of the person in the Norwegian Population Registry","enum":["RESIDENT","RELOCATED","DISAPPEARED","DISEASED","CEASED","REGISTERED_BY_BIRTH","TEMPORARY","INACTIVE","NON_RESIDENT","ACTIVE","UNKNOWN"]},"hasAttachmentCharge":{"type":"boolean","example":true,"description":"Searches through the movables registry (løsøre) to find active attachment charges (UTLEGG/UTPANTING)."},"residentialAddress":{"type":["object","null"],"title":"ResidentialAddress","description":"The persons Norwegian residential address. May be null, if the person is living in a foreign country.","properties":{"updatedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"street":{"type":"object","properties":{"name":{"type":"string","example":"Rudvegen"},"number":{"type":"string","example":"57"},"letter":{"type":["string","null"],"example":"A"}}},"municipality":{"type":"object","properties":{"name":{"type":"string","example":"NESBYEN"},"number":{"type":"string","example":"3540"}}}}},"family":{"type":"object","properties":{"numChildrenBelowAge18":{"type":"integer","description":"Number of persons in the family that are below 18 years of age"},"members":{"type":"array","items":{"type":"object","properties":{"ssn":{"type":"string","example":"03028711300","description":"11 digit identification number of the person."},"age":{"type":"integer","example":34},"gender":{"type":"string","enum":["FEMALE","MALE"]},"relation":{"type":"string","enum":["PARENT","SPOUSE_OR_PARTNER","CHILD","SIBLING"],"description":"The persons relation to the family member."}}}}}},"property":{"type":"object","title":"PropertyOverview","description":"Aggregation of Kartverket API and Eiendomsverdi API","properties":{"ownsProperty":{"type":"boolean","example":true},"properties":{"type":"array","items":{"type":"object","title":"Property","discriminator":{"propertyName":"type","mapping":{"SelfOwnedProperty":"./SelfOwnedProperty.yaml","HousingCooperative":"./HousingCooperative.yaml"}},"anyOf":[{"type":"object","title":"SelfOwnedProperty","properties":{"id":{"type":"string","example":"039456312"},"type":{"type":"string","enum":["SELF_OWNED","HOUSING_COOPERATIVE"],"example":"SELF_OWNED"},"value":{"type":"number","format":"double","example":5000000},"valueEstimate":{"type":"number","format":"double","example":5000000},"valueEstimateHaircut":{"type":"number","format":"double","example":5000000},"commonDebt":{"type":"number","format":"double","example":5000000},"netValueEstimate":{"type":"number","format":"double","example":2000000},"grossValueEstimate":{"type":"number","format":"double","example":2000000},"areaMarketScore":{"type":"integer","example":20,"minimum":1,"maximum":20},"municipalityScore":{"type":"integer","example":20,"minimum":1,"maximum":20},"customerApprovedValue":{"type":"integer","example":20},"valueEstimateAccuracyLevel":{"type":"number","format":"double","example":4},"purchasedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"cadastralUnitNumber":{"type":["string","null"],"example":"7"},"propertyUnitNumber":{"type":["string","null"],"example":"391"},"leaseholdNumber":{"type":["string","null"],"example":"0"},"condominiumUnitNumber":{"type":["string","null"],"example":"0"},"ownershipShare":{"type":"number","example":0.5},"estateType":{"type":"string","enum":["APARTMENT","DETACHED_HOUSE","TERRACED_HOUSE","SEMI_DETACHED_HOUSE","LEISURE_HOME","DORM","RESIDENTIAL_PLOT","CABIN_PLOT","SCHOOL_KINDERGARTEN","COMMERCIAL_BUILDING","FARM","HOUSING","HOUSE","SHARED_HOUSING","GARAGE","UNDEVELOPED","PUBLIC","HEALTH","MEDIA_COMM","CULTURE_AND_SPORTS","RELIGION","TRANSPORTATION","OTHER","UNKNOWN"],"example":"DETACHED_HOUSE"},"street":{"title":"Street","type":"object","properties":{"name":{"type":["string","null"],"example":"Smedstusvingen"},"number":{"type":["string","null"],"example":"18"},"letter":{"type":["string","null"],"example":"A"}}},"zip":{"title":"Zip","type":"object","properties":{"code":{"type":["string","null"],"example":"1480"},"area":{"type":["string","null"],"example":"SLATTUM"}}},"municipality":{"title":"Municipality","type":"object","properties":{"number":{"type":["string","null"],"example":"3031"},"area":{"type":["string","null"],"example":"NITTEDAL"}}},"liens":{"type":"array","items":{"title":"Lien","type":"object","properties":{"id":{"type":"string","example":"039456312"},"updatedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"creditorName":{"type":"string","example":"SPAREBANKEN TELEMARK"},"creditorOrgNumber":{"type":"string","example":"985621551"},"value":{"type":"number","example":4500000}}}}}},{"type":"object","title":"HousingCooperative","properties":{"id":{"type":"string","example":"039456312"},"type":{"type":"string","enum":["SELF_OWNED","HOUSING_COOPERATIVE"],"example":"SELF_OWNED"},"value":{"type":"number","format":"double","example":5000000},"valueEstimate":{"type":"number","format":"double","example":5000000},"valueEstimateHaircut":{"type":"number","format":"double","example":5000000},"commonDebt":{"type":"number","format":"double","example":5000000},"netValueEstimate":{"type":"number","format":"double","example":2000000},"grossValueEstimate":{"type":"number","format":"double","example":2000000},"areaMarketScore":{"type":"integer","example":20,"minimum":1,"maximum":20},"municipalityScore":{"type":"integer","example":20,"minimum":1,"maximum":20},"customerApprovedValue":{"type":"integer","example":20},"valueEstimateAccuracyLevel":{"type":"number","format":"double","example":4},"purchasedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"cadastralUnitNumber":{"type":["string","null"],"example":"7"},"propertyUnitNumber":{"type":["string","null"],"example":"391"},"leaseholdNumber":{"type":["string","null"],"example":"0"},"condominiumUnitNumber":{"type":["string","null"],"example":"0"},"ownershipShare":{"type":"number","example":0.5},"estateType":{"type":"string","enum":["APARTMENT","DETACHED_HOUSE","TERRACED_HOUSE","SEMI_DETACHED_HOUSE","LEISURE_HOME","DORM","RESIDENTIAL_PLOT","CABIN_PLOT","SCHOOL_KINDERGARTEN","COMMERCIAL_BUILDING","FARM","HOUSING","HOUSE","SHARED_HOUSING","GARAGE","UNDEVELOPED","PUBLIC","HEALTH","MEDIA_COMM","CULTURE_AND_SPORTS","RELIGION","TRANSPORTATION","OTHER","UNKNOWN"],"example":"DETACHED_HOUSE"},"street":{"title":"Street","type":"object","properties":{"name":{"type":["string","null"],"example":"Smedstusvingen"},"number":{"type":["string","null"],"example":"18"},"letter":{"type":["string","null"],"example":"A"}}},"zip":{"title":"Zip","type":"object","properties":{"code":{"type":["string","null"],"example":"1480"},"area":{"type":["string","null"],"example":"SLATTUM"}}},"municipality":{"title":"Municipality","type":"object","properties":{"number":{"type":["string","null"],"example":"3031"},"area":{"type":["string","null"],"example":"NITTEDAL"}}},"housingCooperative":{"title":"HousingCooperativeInformation","type":"object","properties":{"id":{"type":"string","example":"5424543"},"name":{"type":"string","example":"TERTITTEN BORETTSLAG"},"orgID":{"type":"string","example":"12345678911"},"shareNumber":{"type":"string","example":25}}},"liens":{"type":"array","items":{"title":"Lien","type":"object","properties":{"id":{"type":"string","example":"039456312"},"updatedAt":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"creditorName":{"type":"string","example":"SPAREBANKEN TELEMARK"},"creditorOrgNumber":{"type":"string","example":"985621551"},"value":{"type":"number","example":4500000}}}}}}]}}}},"debt":{"type":"object","properties":{"sumEstimatedBalance":{"type":"number","format":"double","example":40000000},"sumOriginalBalance":{"type":"number","format":"double","example":60000000},"mortgageDebt":{"title":"MortgageDebtOverview","type":"object","properties":{"sumEstimatedBalance":{"type":"number","format":"double","example":40000000},"sumOriginalBalance":{"type":"number","format":"double","example":60000000},"debts":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"creditorName":{"type":"string","example":"CREDITOR NAME"},"estimatedBalance":{"type":"number","format":"double","example":4107055.83,"description":"An estimate of what the balance might be today."},"originalBalance":{"type":"number","format":"double","example":4407055.83,"description":"The balance gathered from the data source."},"updatedAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Updated date in the source registry."},"createdAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Created date in the source registry."},"estimatedDuration":{"type":"number","example":260,"description":"Specifies the estimated duration in months used in the amortization calculations"},"estimatedRemainingDuration":{"type":"number","example":180,"description":"Specifies the estimated remaining duration in months of the loan"},"estimatedNominalInterestRate":{"type":"number","example":13.4,"format":"double","description":"Specifies the estimated nominal interest rate used in the amortization calculations"},"estimatedMonthlyPayment":{"type":"number","example":2980.45,"format":"double","description":"Specifies the estimated monthly downpayment as a result of the amortization calculations"}}},{"type":"object","properties":{"adjustedOriginalBalance":{"type":"number","format":"double","example":50000000,"description":"The assumed actual original balance of the mortgage."},"balanceSource":{"type":"string","enum":["KARTVERKET"],"example":"KARTVERKET","description":"Specifies which source the originalBalance and estimatedBalance come from."},"lienId":{"type":["string","null"],"example":"288863652"},"propertyId":{"type":["string","null"],"example":"3713739"}}}]}}}},"autoDebt":{"title":"AutoDebtOverview","type":"object","properties":{"sumEstimatedBalance":{"type":"number","format":"double","example":40000000},"sumOriginalBalance":{"type":"number","format":"double","example":60000000},"debts":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"creditorName":{"type":"string","example":"CREDITOR NAME"},"estimatedBalance":{"type":"number","format":"double","example":4107055.83,"description":"An estimate of what the balance might be today."},"originalBalance":{"type":"number","format":"double","example":4407055.83,"description":"The balance gathered from the data source."},"updatedAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Updated date in the source registry."},"createdAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Created date in the source registry."},"estimatedDuration":{"type":"number","example":260,"description":"Specifies the estimated duration in months used in the amortization calculations"},"estimatedRemainingDuration":{"type":"number","example":180,"description":"Specifies the estimated remaining duration in months of the loan"},"estimatedNominalInterestRate":{"type":"number","example":13.4,"format":"double","description":"Specifies the estimated nominal interest rate used in the amortization calculations"},"estimatedMonthlyPayment":{"type":"number","example":2980.45,"format":"double","description":"Specifies the estimated monthly downpayment as a result of the amortization calculations"}}},{"type":"object","properties":{"registrationNumber":{"type":"string","example":"BP22352","description":"The registration number of the vehicle."},"balanceSource":{"type":"string","enum":["LOSOREREGISTERET"],"example":"LOSOREREGISTERET","description":"Specifies which source the originalBalance and estimatedBalance come from."}}}]}}}},"unsecuredDebt":{"title":"UnsecuredDebtOverview","type":"object","properties":{"sumBalance":{"type":"number","format":"double","example":40000000},"sumOriginalBalance":{"type":"number","format":"double","example":60000000},"sumCreditLimit":{"type":"number","format":"double","example":60000000},"debts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"CREDIT_FACILITY","enum":["CREDIT_FACILITY","CHARGE_CARD","REPAYMENT_LOAN"]},"createdAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Created date in the source registry."},"updatedAt":{"type":"string","example":"2019-09-07T15:50+00Z","description":"Created date in the source registry."},"creditorOrgNumber":{"type":"string","example":"983521592","description":"Organization number of the creditor"},"creditorName":{"type":"string","example":"SANTANDER CONSUMER BANK AS","description":"Name of the creditor"},"coBorrower":{"type":"string","enum":["HAS_CO_BORROWER","NO_CO_BORROWER","IS_CO_BORROWER"],"example":"HAS_CO_BORROWER","description":"Specifies the coborrower status. HAS_CO_BORROWER means the loan has a co-borrower, NO_CO_BORROWER means there are no co-borrowers, IS_CO_BORROWER means the applicant is a co-borrower of this loan."},"balance":{"type":"number","example":400000,"description":"Outstanding balance of the loan."},"originalBalance":{"type":"number","example":400000,"description":"Applies only to type REPAYMENT_LOAN"},"creditLimit":{"type":"number","example":30000,"description":"Applies only to type CREDIT_FACILITY"},"installmentCharges":{"type":"number","example":40},"installmentChargePeriod":{"type":"string","enum":["MONTHLY","QUARTERLY","HALF_YEARLY","YEARLY"],"example":"MONTHLY"},"interestBearingBalance":{"type":"number","example":55000},"nonInterestBearingBalance":{"type":"number","example":20000},"nomInterestRate":{"type":"number","format":"double","example":12.3},"paymentsPerYear":{"type":"number","example":12},"duration":{"type":"number","example":12,"description":"Applies only to type REPAYMENT_LOAN"}}}}}}}}}}]}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"BadRequestResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["BadRequest"],"example":"BadRequest"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["400-000","400-001","400-002","400-003","400-004","400-005","400-006","400-007","400-008","400-100","400-101","400-102","400-103","400-104","400-105","400-106","400-107","400-108","400-109","400-110","400-111","400-112"],"example":"400-001"},"message":{"type":"string","example":"Field 'ssn' is required"}}}}}}}}},"401":{"description":"Unauthorized","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"UnauthorizedResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Unauthorized"],"example":"Unauthorized"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["401-000","401-001","401-002","401-003","401-004","401-005","401-006","401-007"],"example":"401-000"},"message":{"type":"string","example":"Client is not authenticated"}}}}}}}}},"403":{"description":"Bad Request","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ForbiddenResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["Forbidden"],"example":"Forbidden"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["403-000","403-001"],"example":"403-000"},"message":{"type":"string","example":"Client does not have access to this resource"}}}}}}}}},"404":{"description":"Not Found","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"NotFoundResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["NotFound"],"example":"NotFound"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["404-000","404-001","404-002"],"example":"404-000"},"message":{"type":"string","example":"The requested resource was not found"}}}}}}}}},"429":{"description":"Too Many Requests. When the rate limit rejects a request, the response carries `Retry-After` and only the `errors` field: no `timestamp`, `moreInfo` or `X-Request-ID`, as the request never reached the API.","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"Retry-After":{"description":"Seconds to wait before retrying. Sent when the rate limit rejects a request.","schema":{"type":"integer","example":60}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TooManyRequestsResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["TooManyRequests"],"example":"TooManyRequests"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["429-000"],"example":"429-000"},"message":{"type":"string","example":"Too many requests. Please try again later."}}}}}}}}},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"InternalServerErrorResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["InternalServerError"],"example":"InternalServerError"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["500-000","500-001"],"example":"500-000"},"message":{"type":"string","example":"An unexpected internal error occurred"}}}}}}}}},"503":{"description":"Service Unavailable","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"ServiceUnavailableResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["ServiceUnavailable"],"example":"ServiceUnavailable"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["503-000"],"example":"503-000"},"message":{"type":"string","example":"An error occurred while interacting with a third party service"}}}}}}}}},"504":{"description":"Gateway Timeout","headers":{"Content-Type":{"description":"The content type of the response.","example":"application/json; charset=utf-8","schema":{"type":"string","enum":["application/json; charset=utf-8"]}},"X-Request-ID":{"description":"UUID generated on each request. Provide this id to customer support if an error occurs.","schema":{"type":"string","format":"uuid","example":"0679c533-5061-496e-8dc5-df786f04a209"}}},"content":{"application/json":{"schema":{"title":"TimeoutResponse","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2019-09-16T22:14:45.624Z"},"moreInfo":{"type":"string","format":"url","example":"https://docs.neobits.ai/"},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["GatewayTimeout"],"example":"GatewayTimeout"},"code":{"type":"string","description":"Unique error code in format HTTP_STATUS-SEQUENCE","enum":["504-000"],"example":"504-000"},"message":{"type":"string","example":"The request timed out"}}}}}}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer token authentication using OAuth 2.0 client credentials flow."},"basic":{"type":"http","scheme":"basic","description":"Basic authentication, base64 encoded username:password."}}}}