{
  "openapi": "3.0.1",
  "info": {
    "title": "Fenergo Nebula Adapter Receptor",
    "description": "**CreditScreening Adapter Receptor**:\n\n<br> CreditScreening Adapter Receptor API provides both configurational and operational methods related to the client creditscreenings. Use the CreditScreening Command API to create and update new and existing creditscreenings. Use the Query API to retrieve creditscreenings and aggregates.\n\n<br> **CreditScreening Command API provides**:<br><ul><li> The ability to create, update and delete CreditScreenings.</li><li> The ability to related objects of CreditScreenings - Including creating new providers, providers configurations, mapping configurations and adapter schemas.</li></ul>",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "/creditscreeningreceptor"
    }
  ],
  "paths": {
    "/api/receptor/callback": {
      "post": {
        "tags": [
          "Receptor"
        ],
        "summary": "Callback",
        "description": "\nThis method will handle adapters responses.\r\n            Processes Adapter Responses",
        "operationId": "Callback",
        "parameters": [
          {
            "name": "X-TENANT-ID",
            "in": "header",
            "description": "The UiD of the tenant representing organization",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "b11f8be3-f29b-4959-8964-956d4af7c468"
          }
        ],
        "requestBody": {
          "description": "Adapter response",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AdapterResponseDto"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/AdapterResponseDto"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/AdapterResponseDto"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Success. Data Accepted"
          },
          "400": {
            "description": "Bad request. The request has missing/invalid values",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error"
          },
          "401": {
            "description": "User is not authorized to perform this request",
            "content": {
              "application/json": {
                "example": {
                  "message": "Unauthorized"
                }
              }
            }
          },
          "403": {
            "description": "Access to resource is forbidden.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ObjectServiceResponse"
                },
                "example": {
                  "data": { },
                  "messages": [
                    {
                      "message": "Access denied. Following permissions are required: Permission1, Permission2",
                      "type": "Forbidden",
                      "errorCode": "Error Code"
                    }
                  ]
                }
              }
            }
          },
          "410": {
            "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StringServiceResponse"
                },
                "example": {
                  "data": null,
                  "messages": [
                    {
                      "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
                      "type": "Error",
                      "errorCode": "OBSOLETE_ENDPOINT"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AdapterResponseDto": {
        "type": "object",
        "properties": {
          "creditScreeningEnquiryId": {
            "type": "string",
            "nullable": true
          },
          "tenant": {
            "type": "string",
            "nullable": true
          },
          "providerId": {
            "type": "string",
            "nullable": true
          },
          "requestType": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "completedOn": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "errorDetails": {
            "type": "string",
            "nullable": true
          },
          "errorCode": {
            "type": "string",
            "nullable": true
          },
          "response": {
            "type": "object",
            "additionalProperties": { },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ObjectServiceResponse": {
        "type": "object",
        "properties": {
          "data": {
            "nullable": true
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceResponseMessage"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": { }
      },
      "ServiceResponseMessage": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          },
          "errorCode": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StringServiceResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "string",
            "nullable": true
          },
          "messages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceResponseMessage"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  }
}