---
updatedAt: 2025-09-16T11:55:19.000Z
agentTools:
  projectIndex: https://docs.developer.rabobank.com/identity-risk/llms.txt
---

# Create Invitation

Creates an invitation for generating a credit report.


# OpenAPI definition

````json
{
  "openapi": "3.0.0",
  "info": {
    "description": "The CreditEstimate API provides a current and detailed credit report based on transaction data from up to 24 months ago. CreditEstimate uses Rabobank’s proprietary algorithms utilized for SME loan acceptance. This API enables any organization to integrate transaction data-based credit scoring into its acceptance process.\n\n## Features\n- **Input**: Transaction data from Rabobank, ING, ABN Amro, Volksbank, Knab, SNS, ASN Bank, Triodos, and bunq.\n- **Output**: A JSON-formatted report containing:\n  - `CreditScore`\n  - `CashFlowAnalysis`\n\n## Before You Begin\n1. **Setup Requirements**:\n   - Ensure you have a working sandbox account in the Rabobank developer portal.\n   - Read the **Get Started** guide to set up your account and register an application.\n2. **TLS Certificate**:\n   - A valid TLS certificate is required to use these APIs.\n\n## Dataset\n### Sandbox Environment\n- You can use the provided examples or any valid subset in the Sandbox environment.\n- Generated reports use example data. Errors and warnings return hard-coded responses.\n\n## Using the API\n### Workflow Steps\n1. **API-Consumer**: Initiates and generates an invitation for the end-user (e.g., the company being assessed).\n2. **End-user**:\n   - Gives consent.\n   - Authorizes their bank to share transaction data with Rabobank CreditEstimate.\n3. **Report Generation**:\n   - CreditEstimate creates a credit report based on retrieved transactions and Rabobank’s data.\n4. **Sharing**: The end-user decides whether to share the report with the API-Consumer.\n5. **API-Consumer**: Retrieves the report if the end-user shares it.\n\n## Post Invitation Generation\n- The API-consumer calls CreditEstimate to generate a unique link for each end-user. This link can be put in an email, placed behind a website button, or embedded in the flow.\n- The invitation link is generated only if the user is eligible to use CreditEstimate, e.g., the company should have an active registration in the Dutch Chamber of Commerce.\n- The default validity duration of the invite is set to 72 hours but can be customized on the API-consumer’s request.\n- After the end-user opens the invitation link, the user's email address and the company name are pre-filled.\n\n## Set up Callback Functionality\n- Set up the callback functionality for CE SME to receive instant status updates. The `callBackSecret` is a password that you can generate/hash yourself. It is sent back as a header for you to validate the request.\n- Add the `callbackRegistration` to the post-invitation request as shown below:\n\n### Example Request (POST)\n```json\n{\n  \"organizationDetails\": {\n    \"email\": \"test@test.nl\",\n    \"kvkNumber\": \"123456789\"\n  },\n  \"callbackRegistration\": {\n    \"callbackUrl\": \"https://ce.requestcatcher.com/\",\n    \"callbackSecret\": \"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6\"\n  },\n  \"requestedCreditReport\": {\n    \"modules\": [\n      {\n        \"name\": \"CASH_FLOW_ANALYSIS\",\n        \"requested\": true\n      },\n      {\n        \"name\": \"CREDIT_SCORE\",\n        \"requested\": true\n      }\n    ]\n  }\n}\n```\n\n## Examples\n### Create Invitation\n**Request**\nPOST /dls-credit-estimate-api/v1/invitations\n```json\n{\n  \"organizationDetails\": {\n    \"email\": \"fm.nl.its.chapter.bl.emailoutputdls@rabobank.nl\",\n    \"kvkNumber\": \"TEST1001\"\n  },\n  \"requestedCreditReport\": {\n    \"modules\": [\n      {\n        \"name\": \"CASH_FLOW_ANALYSIS\",\n        \"requested\": true\n      },\n      {\n        \"name\": \"CREDIT_SCORE\",\n        \"requested\": true\n      }\n    ]\n  }\n}\n```\n\n**Response**\n```json\n{\n  \"invitationDetails\": {\n    \"invitationCode\": \"o1ju2teg\",\n    \"invitationUrl\": \"https://app.creditestimate.nl/?invitationCode=o1ju2teg\",\n    \"organizationDetails\": {\n      \"kvkNumber\": \"TEST0001\",\n      \"organizationName\": \"Organization under test\",\n      \"legalForm\": \"BESLOTEN_VENNOOTSCHAP\"\n    }\n  },\n  \"modules\": [\n    {\n      \"name\": \"CASH_FLOW_ANALYSIS\",\n      \"requested\": true\n    },\n    {\n      \"name\": \"CREDIT_SCORE\",\n      \"requested\": true\n    }\n  ]\n}\n```\n\n## Additional Examples\n### Get Invitations\n**Request**\nGET https://api-sandbox.rabobank.nl/openapi/sandbox/credit-estimate/v1/invitations\n\n**Response**\n```json\n[\n  {\n    \"createdAt\": \"2024-08-15T13:56:11.564069929Z\",\n    \"expiredAt\": \"2024-09-14T13:56:11.564070223Z\",\n    \"createdBy\": \"a70a0545-ba48-1234-8945-4227798f3908\",\n    \"invitationCode\": \"TESTAB01\",\n    \"invitationUrl\": \"https://app.creditestimate.nl/?invitationCode=TESTAB01\",\n    \"kvkNumber\": \"3456789\",\n    \"organizationName\": \"Test Bakery\",\n    \"organizationEmail\": \"john.doe@Bakkerij.nl\",\n    \"status\": {\n      \"invitationStatus\": \"USER_SET_REPORT_SHARED\",\n      \"isCreditReportAvailable\": true,\n      \"creditReportAvailableUntil\": \"2024-09-14T13:56:11.564073619Z\"\n    }\n  }\n]\n```\n\n### Get Invitation Status\n**Request**\nGET https://api-sandbox.rabobank.nl/openapi/sandbox/credit-estimate/v1/invitations/{invitation-code}/status\n\n**Response**\n```json\n{\n  \"invitationStatus\": \"INVITATION_INITIATED\",\n  \"isCreditReportAvailable\": false\n}\n```\n\n### Get Credit Report\n**Request**\nGET https://api-sandbox.rabobank.nl/openapi/sandbox/credit-estimate/v1/invitations/{invitation-code}/credit-report\n\n**Response**\n```json\n{\n\"generic\": {\n    \"generatedAt\": \"2024-08-15T14:03:44.414732276Z\",\n    \"invitationCode\": \"TEST4001\",\n    \"reportDateRange\": {\n        \"fromDate\": \"2024-08-15\",\n        \"toDate\": \"2023-08-15\"\n    },\n    \"organizationDetails\": {\n        \"kvkNumber\": \"12345678\",\n        \"organizationName\": \"Test Organization\",\n        \"legalForm\": \"BESLOTEN_VENNOOTSCHAP\",\n        \"foundationDate\": \"2022-08-15\",\n        \"sbiCodes\": [\n            {\n                \"code\": \"12345\",\n                \"main\": true\n            },\n            {\n                \"code\": \"67890\",\n                \"main\": false\n            }\n        ],\n        \"bankAccounts\": [\n            {\n                \"iban\": \"NL12BANK0123456789\"\n            }\n        ]\n    }\n},\n\"moduleResults\": {\n    \"creditScore\": {\n        \"creditScore\": 8,\n        \"probabilityOfDefault\": 0.6,\n        \"probabilityOfNonDefault\": 99.4\n    },\n    \"cashFlowAnalysis\": {\n        \"moduleStatus\": {\n            \"moduleStatus\": \"COMPLETE\"\n        }\n    }\n}\n```\n",
    "title": "CreditEstimate API",
    "version": "3.1.5",
    "x-api-id": "0bd58925-4686-4329-bc20-607ca6921828",
    "x-api-type": "partner",
    "x-audience": "external-partner",
    "x-ibm-name": "credit-estimate-api"
  },
  "servers": [
    {
      "url": "https://api.rabobank.nl/openapi/credit-estimate",
      "description": "Production server"
    },
    {
      "url": "https://api-sandbox.rabobank.nl/openapi/sandbox/credit-estimate",
      "description": "Sandbox server"
    }
  ],
  "paths": {
    "/v1/invitations": {
      "post": {
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Invitation"
                }
              },
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Invitation"
                }
              }
            },
            "description": "A successfully created invitation."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TraceableProblem"
                }
              },
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/TraceableProblem"
                }
              }
            },
            "description": "Known CreditEstimate errors."
          },
          "401": {
            "description": "The client is not authorized to access the requested resource."
          },
          "404": {
            "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists."
          },
          "500": {
            "description": "The server has encountered a situation it does not know how to handle."
          }
        },
        "tags": [
          "Invitation"
        ],
        "description": "Creates an invitation for generating a credit report.\n",
        "operationId": "createInvitation",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InvitationRequest"
              }
            }
          },
          "required": true
        },
        "summary": "Create Invitation"
      },
      "x-zally-ignore": 115
    }
  },
  "components": {
    "schemas": {
      "CallbackSecret": {
        "description": "Secret to validate the callback",
        "example": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
        "maxLength": 36,
        "minLength": 20,
        "type": "string"
      },
      "CreditEstimateError": {
        "enum": [
          "UNKNOWN",
          "RANGE_INVALID",
          "DATE_RANGE_CANNOT_EXCEED_TWO_YEARS",
          "CREDIT_SCORE_REQUIRES_TO_DATE_TO_EQUAL_TODAY",
          "CREDIT_SCORE_INVALID_DATE_RANGE",
          "CASH_FLOW_ANALYSIS_INVALID_DATE_RANGE",
          "NO_REQUESTED_MODULE",
          "REQUESTED_MODULE_NOT_IN_CONTRACT",
          "EXTERNAL_SERVICE_UNAVAILABLE",
          "LEGAL_FORM_NOT_SUPPORTED",
          "SBI_CODE_NOT_SUPPORTED",
          "SBI_CODE_UNKNOWN",
          "ORGANIZATION_TOO_YOUNG",
          "KVK_NOT_FOUND",
          "PARTNER_INVALID",
          "INVITATION_ALREADY_EXISTENT",
          "ERROR_WITH_TRANSACTION_DATA",
          "CREDIT_REPORT_NOT_AVAILABLE",
          "CREDIT_REPORT_UNAVAILABLE_INVITATION_EXPIRED",
          "CREDIT_REPORT_NO_LONGER_AVAILABLE"
        ],
        "type": "string"
      },
      "Date": {
        "example": "2019-01-01",
        "format": "date",
        "type": "string"
      },
      "DateRange": {
        "description": "The specified range of transactions to be used in calculating the credit report is contained within this object. However, there may be situations where obtaining the exact required range is not feasible.\n",
        "properties": {
          "fromDate": {
            "$ref": "#/components/schemas/Date"
          },
          "toDate": {
            "$ref": "#/components/schemas/Date"
          }
        },
        "required": [
          "fromDate",
          "toDate"
        ],
        "type": "object"
      },
      "Email": {
        "example": "john_doe@gmail.com",
        "maxLength": 320,
        "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
        "type": "string"
      },
      "Invitation": {
        "properties": {
          "invitationDetails": {
            "properties": {
              "invitationCode": {
                "$ref": "#/components/schemas/InvitationCode"
              },
              "invitationUrl": {
                "$ref": "#/components/schemas/InvitationUrl"
              },
              "organizationDetails": {
                "$ref": "#/components/schemas/OrganizationDetails"
              }
            },
            "required": [
              "invitationCode",
              "invitationUrl",
              "organizationDetails"
            ],
            "type": "object"
          },
          "modules": {
            "items": {
              "$ref": "#/components/schemas/ModuleRequest"
            },
            "type": "array"
          }
        },
        "required": [
          "invitationDetails",
          "modules"
        ],
        "type": "object"
      },
      "InvitationCode": {
        "example": "c1571a8a",
        "maxLength": 8,
        "minLength": 8,
        "type": "string"
      },
      "InvitationRequest": {
        "properties": {
          "callbackRegistration": {
            "properties": {
              "callbackSecret": {
                "$ref": "#/components/schemas/CallbackSecret"
              },
              "callbackUrl": {
                "description": "URL to call when the invitation status changes",
                "example": "https://www.partner.nl/callback",
                "format": "uri",
                "type": "string"
              }
            },
            "required": [
              "callbackSecret",
              "callbackUrl"
            ],
            "type": "object"
          },
          "createdBy": {
            "$ref": "#/components/schemas/UserId"
          },
          "invitationSpecificReturnUrl": {
            "$ref": "#/components/schemas/InvitationSpecificReturnUrl"
          },
          "organizationDetails": {
            "$ref": "#/components/schemas/OrganizationDetailsRequest"
          },
          "requestedCreditReport": {
            "$ref": "#/components/schemas/RequestedCreditReport"
          }
        },
        "required": [
          "organizationDetails"
        ],
        "type": "object"
      },
      "InvitationSpecificReturnUrl": {
        "description": "Optional (dynamic) return URL set for this specific invitation.",
        "example": "https://www.partner.nl/returnToPartner/70222995-a5a7-44e0-9dfc-888b42062698",
        "type": "string"
      },
      "InvitationUrl": {
        "example": "https://creditestimate.nl/?invitationCode=894aa076",
        "type": "string"
      },
      "KvkNumber": {
        "example": "04039265",
        "maxLength": 8,
        "minLength": 8,
        "pattern": "^[0-9]{8}$",
        "type": "string"
      },
      "LegalForm": {
        "enum": [
          "BESLOTEN_VENNOOTSCHAP",
          "BUITENLANDSE_RECHTSVORM",
          "COMMANDITAIRE_VENNOOTSCHAP",
          "COOPERATIE",
          "EENMANSZAAK",
          "KERKGENOOTSCHAP",
          "MAATSCHAP",
          "NAAMLOZE_VENNOOTSCHAP",
          "REDERIJ",
          "STICHTING",
          "VERENIGING",
          "VENNOOTSCHAP_ONDER_FIRMA"
        ],
        "example": "BESLOTEN_VENNOOTSCHAP",
        "type": "string"
      },
      "ModuleName": {
        "enum": [
          "CREDIT_SCORE",
          "CASH_FLOW_ANALYSIS"
        ],
        "type": "string"
      },
      "ModuleRequest": {
        "properties": {
          "name": {
            "$ref": "#/components/schemas/ModuleName"
          },
          "requested": {
            "example": true,
            "type": "boolean"
          }
        },
        "required": [
          "name",
          "requested"
        ],
        "type": "object"
      },
      "OrganizationDetails": {
        "properties": {
          "kvkNumber": {
            "$ref": "#/components/schemas/KvkNumber"
          },
          "legalForm": {
            "$ref": "#/components/schemas/LegalForm"
          },
          "organizationName": {
            "$ref": "#/components/schemas/OrganizationName"
          }
        },
        "required": [
          "kvkNumber",
          "legalForm",
          "organizationName"
        ],
        "type": "object"
      },
      "OrganizationDetailsRequest": {
        "properties": {
          "email": {
            "$ref": "#/components/schemas/Email"
          },
          "kvkNumber": {
            "$ref": "#/components/schemas/KvkNumber"
          }
        },
        "required": [
          "email",
          "kvkNumber"
        ],
        "type": "object"
      },
      "OrganizationName": {
        "example": "Food bar B.V.",
        "type": "string"
      },
      "RequestedCreditReport": {
        "properties": {
          "modules": {
            "example": [
              {
                "name": "CREDIT_SCORE",
                "requested": true
              },
              {
                "name": "CASH_FLOW_ANALYSIS",
                "requested": false
              }
            ],
            "items": {
              "$ref": "#/components/schemas/ModuleRequest"
            },
            "type": "array"
          },
          "requestedDateRange": {
            "$ref": "#/components/schemas/DateRange"
          }
        },
        "type": "object"
      },
      "TraceableProblem": {
        "properties": {
          "description": {
            "example": "SBI blacklisted by CreditEstimate",
            "type": "string"
          },
          "errorCode": {
            "$ref": "#/components/schemas/CreditEstimateError"
          },
          "invitationCode": {
            "$ref": "#/components/schemas/InvitationCode"
          }
        },
        "required": [
          "description",
          "errorCode"
        ],
        "type": "object"
      },
      "UserId": {
        "format": "uuid",
        "type": "string"
      }
    },
    "securitySchemes": {
      "clientId": {
        "description": "ClientId as provided by the Rabobank developer portal.",
        "in": "header",
        "name": "X-IBM-Client-Id",
        "type": "apiKey"
      }
    }
  },
  "security": [
    {
      "clientId": []
    }
  ],
  "x-components": {
    "parameters": {
      "invitation-code": {
        "description": "Path parameter with the invitation code of the credit report.",
        "in": "path",
        "maxLength": 8,
        "minLength": 8,
        "name": "invitation-code",
        "required": true,
        "type": "string"
      }
    },
    "responses": {
      "BadRequest": {
        "description": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."
      },
      "Forbidden": {
        "description": "The server understood the request but refuses to authorize it."
      },
      "InternalServerError": {
        "description": "The server has encountered a situation it does not know how to handle."
      },
      "NoContent": {
        "description": "The server has accepted the request."
      },
      "NotFound": {
        "description": "The origin server did not find a current representation for the target resource or is not willing to disclose that one exists."
      },
      "TooManyRequests": {
        "description": "The user has sent too many requests in a given amount of time (\"rate limiting\")."
      },
      "TraceableProblem": {
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/TraceableProblem"
            }
          }
        },
        "description": "Traceable Problem"
      },
      "Unauthorized": {
        "description": "The client is not authorized to access the requested resource."
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-zally-ignore": [
    104,
    105,
    110,
    115,
    134,
    153,
    224
  ]
}
````