openapi: 3.0.1 info: title: v2.2 termsOfService: / license: name: 'Apache 2.0' url: 'http://www.apache.org/licenses/LICENSE-2.0.html' version: v2.2 servers: - url: /v2.2/ paths: /infoservice/crif/score/concheck/: post: tags: - infoservice summary: 'CRIF b.ONE - ConCheck' operationId: crifScoreConCheck parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar requestBody: content: application/json: schema: required: - Order - Person - Address type: object properties: Order: allOf: - type: object properties: CustomerReference: maxLength: 40 type: string ProofOfInterest: enum: - 1 - 2 - 3 - 4 type: integer x-enumNames: - Kreditanfrage - Geschäftsanbahnung - Bonitätsprüfung - Forderung ReportFormat: enum: - NONE - PDF type: string IdentCheckVariant: enum: - Standard - Jugendschutz - Premium type: string RequestFeatureCode: maxLength: 2 type: string x-tags: - infoservice - required: - ProofOfInterest - ReportFormat type: object example: CustomerReference: 6910-2 ProofOfInterest: 3 ReportFormat: NONE Person: allOf: - type: object properties: Title: maxLength: 30 type: string example: 'Prof. Dr.' FirstName: maxLength: 40 type: string example: Max LastName: maxLength: 40 type: string example: Mustermann Gender: enum: - u - m - w - f type: string example: m x-enumNames: - unknown - male - female - female BirthDate: type: string format: date example: '2001-05-08' BirthPlace: maxLength: 24 type: string example: '' x-tags: - infoservice - required: - FirstName - LastName type: object Address: required: - Street - HouseNumber - PostalCode - City - CountryCode type: object properties: Street: maxLength: 40 type: string example: 'Weiße Breite' HouseNumber: maxLength: 10 type: string example: 5-7 PostalCode: maxLength: 10 type: string example: '49084' City: maxLength: 40 type: string example: Osnabrück CountryCode: enum: - DE type: string example: DE x-tags: - infoservice x-tags: - infoservice responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: Response: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Operation successful' x-tags: - infoservice description: 'array of Messages' sRaw: type: string example: '...' x-tags: - infoservice Data: type: object properties: ServiceReference: type: string example: '3522258114' CustomerReference: maxLength: 40 type: string example: 6910-2 ScoreValue: type: string example: '1.50' Identification: allOf: - type: object properties: Code: maxLength: 4 type: string Text: maxLength: 255 type: string x-tags: - infoservice - type: object example: Code: NW Text: 'Person unknown/address known' Risk: allOf: - type: object properties: Code: maxLength: 4 type: string Text: maxLength: 255 type: string x-tags: - infoservice - type: object example: Code: B10 Text: 'Statistical risk of default: average' x-tags: - infoservice DataBase64Encoded: type: string format: byte example: '' x-tags: - infoservice '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '422': description: 'Unprocessable Entity' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: info sValue: 'OpenApi check failed (code AWX494)' sData: '' '500': description: 'internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' /infoservice/crif/score/concheckplusident/: post: tags: - infoservice summary: 'CRIF b.ONE - ConCheck PlusIdent' operationId: crifScoreConCheckPlusIdent parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar requestBody: content: application/json: schema: required: - Order - Person - Address type: object properties: Order: allOf: - type: object properties: CustomerReference: maxLength: 40 type: string ProofOfInterest: enum: - 1 - 2 - 3 - 4 type: integer x-enumNames: - Kreditanfrage - Geschäftsanbahnung - Bonitätsprüfung - Forderung ReportFormat: enum: - NONE - PDF type: string IdentCheckVariant: enum: - Standard - Jugendschutz - Premium type: string RequestFeatureCode: maxLength: 2 type: string x-tags: - infoservice - required: - ProofOfInterest - ReportFormat type: object example: CustomerReference: 6910-2 ProofOfInterest: 3 ReportFormat: NONE Person: allOf: - type: object properties: Title: maxLength: 30 type: string example: 'Prof. Dr.' FirstName: maxLength: 40 type: string example: Max LastName: maxLength: 40 type: string example: Mustermann Gender: enum: - u - m - w - f type: string example: m x-enumNames: - unknown - male - female - female BirthDate: type: string format: date example: '2001-05-08' BirthPlace: maxLength: 24 type: string example: '' x-tags: - infoservice - required: - FirstName - LastName type: object Address: required: - Street - HouseNumber - PostalCode - City - CountryCode type: object properties: Street: maxLength: 40 type: string example: 'Weiße Breite' HouseNumber: maxLength: 10 type: string example: 5-7 PostalCode: maxLength: 10 type: string example: '49084' City: maxLength: 40 type: string example: Osnabrück CountryCode: enum: - DE type: string example: DE x-tags: - infoservice x-tags: - infoservice responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: Response: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Operation successful' x-tags: - infoservice description: 'array of Messages' sRaw: type: string example: '...' x-tags: - infoservice Data: type: object properties: ServiceReference: type: string example: '3522258114' CustomerReference: maxLength: 40 type: string example: 6910-2 ScoreValue: type: string example: '1.50' Identification: allOf: - type: object properties: Code: maxLength: 4 type: string Text: maxLength: 255 type: string x-tags: - infoservice - type: object example: Code: NW Text: 'Person unknown/address known' Risk: allOf: - type: object properties: Code: maxLength: 4 type: string Text: maxLength: 255 type: string x-tags: - infoservice - type: object example: Code: B10 Text: 'Statistical risk of default: average' x-tags: - infoservice DataBase64Encoded: type: string format: byte example: '' x-tags: - infoservice '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '422': description: 'Unprocessable Entity' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: info sValue: 'OpenApi check failed (code AWX494)' sData: '' '500': description: 'internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' /infoservice/crif/score/riskcheckbusiness/: post: tags: - infoservice summary: 'CRIF b.ONE - RiskCheck Business' operationId: crifScoreRiskCheckBusiness parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar requestBody: content: application/json: schema: required: - Order - Company - Address type: object properties: Order: allOf: - type: object properties: CustomerReference: maxLength: 40 type: string ProofOfInterest: enum: - 1 - 2 - 3 - 4 type: integer x-enumNames: - Kreditanfrage - Geschäftsanbahnung - Bonitätsprüfung - Forderung ReportFormat: enum: - NONE - PDF type: string IdentCheckVariant: enum: - Standard - Jugendschutz - Premium type: string RequestFeatureCode: maxLength: 2 type: string x-tags: - infoservice - required: - ProofOfInterest - ReportFormat type: object example: CustomerReference: 6910-2 ProofOfInterest: 3 ReportFormat: NONE Company: required: - CompanyName type: object properties: CompanyName: maxLength: 60 type: string example: 'Mustermann GmbH' CommercialRegisterNumber: maxLength: 20 type: string example: 'HRB 230807' VAT_ID: maxLength: 15 type: string example: DE123456789 x-tags: - infoservice Address: required: - Street - HouseNumber - PostalCode - City - CountryCode type: object properties: Street: maxLength: 40 type: string example: 'Weiße Breite' HouseNumber: maxLength: 10 type: string example: 5-7 PostalCode: maxLength: 10 type: string example: '49084' City: maxLength: 40 type: string example: Osnabrück CountryCode: enum: - DE type: string example: DE x-tags: - infoservice x-tags: - infoservice responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: Response: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Operation successful' x-tags: - infoservice description: 'array of Messages' sRaw: type: string example: '...' x-tags: - infoservice Data: type: object properties: ServiceReference: type: string example: '3522258114' CustomerReference: maxLength: 40 type: string example: 6910-2 ScoreValue: type: string example: '1.50' Identification: allOf: - type: object properties: Code: maxLength: 4 type: string Text: maxLength: 255 type: string x-tags: - infoservice - type: object example: Code: NW Text: 'Person unknown/address known' Risk: allOf: - type: object properties: Code: maxLength: 4 type: string Text: maxLength: 255 type: string x-tags: - infoservice - type: object example: Code: B10 Text: 'Statistical risk of default: average' x-tags: - infoservice DataBase64Encoded: type: string format: byte example: '' x-tags: - infoservice '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '422': description: 'Unprocessable Entity' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: info sValue: 'OpenApi check failed (code AWX494)' sData: '' '500': description: 'internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' /infoservice/crif/score/negativecheckhard/: post: tags: - infoservice summary: 'CRIF b.ONE - NegativeCheckHard' operationId: negativeCheckHard parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar requestBody: content: application/json: schema: required: - Order - Person - Address type: object properties: Order: allOf: - type: object properties: CustomerReference: maxLength: 40 type: string ProofOfInterest: enum: - 1 - 2 - 3 - 4 type: integer x-enumNames: - Kreditanfrage - Geschäftsanbahnung - Bonitätsprüfung - Forderung ReportFormat: enum: - NONE - PDF type: string IdentCheckVariant: enum: - Standard - Jugendschutz - Premium type: string RequestFeatureCode: maxLength: 2 type: string x-tags: - infoservice - required: - ProofOfInterest - ReportFormat type: object example: CustomerReference: 6910-2 ProofOfInterest: 3 ReportFormat: NONE Person: allOf: - type: object properties: Title: maxLength: 30 type: string example: 'Prof. Dr.' FirstName: maxLength: 40 type: string example: Max LastName: maxLength: 40 type: string example: Mustermann Gender: enum: - u - m - w - f type: string example: m x-enumNames: - unknown - male - female - female BirthDate: type: string format: date example: '2001-05-08' BirthPlace: maxLength: 24 type: string example: '' x-tags: - infoservice - required: - FirstName - LastName type: object Address: required: - Street - HouseNumber - PostalCode - City - CountryCode type: object properties: Street: maxLength: 40 type: string example: 'Weiße Breite' HouseNumber: maxLength: 10 type: string example: 5-7 PostalCode: maxLength: 10 type: string example: '49084' City: maxLength: 40 type: string example: Osnabrück CountryCode: enum: - DE type: string example: DE x-tags: - infoservice x-tags: - infoservice responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: Response: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Operation successful' x-tags: - infoservice description: 'array of Messages' sRaw: type: string example: '...' x-tags: - infoservice Data: type: object properties: ServiceReference: type: string example: '3522258114' CustomerReference: maxLength: 40 type: string example: 6910-2 ScoreValue: type: string example: '1.50' Identification: allOf: - type: object properties: Code: maxLength: 4 type: string Text: maxLength: 255 type: string x-tags: - infoservice - type: object example: Code: NW Text: 'Person unknown/address known' Risk: allOf: - type: object properties: Code: maxLength: 4 type: string Text: maxLength: 255 type: string x-tags: - infoservice - type: object example: Code: B10 Text: 'Statistical risk of default: average' x-tags: - infoservice DataBase64Encoded: type: string format: byte example: '' x-tags: - infoservice '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '500': description: 'internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' /infoservice/schufa/identcheck/childprotection/: post: tags: - infoservice summary: 'Schufa IdentCheck ChildProtection' operationId: schufaIdentCheckChildProtection parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar requestBody: content: application/json: schema: required: - Order - Person - Address type: object properties: Order: allOf: - type: object properties: CustomerReference: maxLength: 40 type: string ProofOfInterest: enum: - 1 - 2 - 3 - 4 type: integer x-enumNames: - Kreditanfrage - Geschäftsanbahnung - Bonitätsprüfung - Forderung ReportFormat: enum: - NONE - PDF type: string IdentCheckVariant: enum: - Standard - Jugendschutz - Premium type: string RequestFeatureCode: maxLength: 2 type: string x-tags: - infoservice - required: - IdentCheckVariant type: object example: CustomerReference: 6910-2 IdentCheckVariant: Jugendschutz Person: allOf: - type: object properties: Title: maxLength: 30 type: string example: 'Prof. Dr.' FirstName: maxLength: 40 type: string example: Max LastName: maxLength: 40 type: string example: Mustermann Gender: enum: - u - m - w - f type: string example: m x-enumNames: - unknown - male - female - female BirthDate: type: string format: date example: '2001-05-08' BirthPlace: maxLength: 24 type: string example: '' x-tags: - infoservice - required: - FirstName - LastName - Gender - BirthDate type: object Address: required: - Street - HouseNumber - PostalCode - City - CountryCode type: object properties: Street: maxLength: 40 type: string example: 'Weiße Breite' HouseNumber: maxLength: 10 type: string example: 5-7 PostalCode: maxLength: 10 type: string example: '49084' City: maxLength: 40 type: string example: Osnabrück CountryCode: enum: - DE type: string example: DE x-tags: - infoservice x-tags: - infoservice responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: Response: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Operation successful' x-tags: - infoservice description: 'array of Messages' sRaw: type: string example: '...' x-tags: - infoservice Data: type: object properties: ServiceReference: type: string example: '3522258114' CustomerReference: maxLength: 40 type: string example: 6910-2 ReturnCode: type: string example: '' FoundWithPreviousAddress: type: boolean example: false IdentityVerified: type: boolean example: true Match: type: array items: type: object properties: sField: type: string example: FirstName sMatchQuality: type: string example: '100.0' x-tags: - infoservice Consumer: type: object properties: FirstName: maxLength: 40 type: string example: Max LastName: maxLength: 40 type: string example: Mustermann Gender: type: string example: m BirthDate: type: string format: date example: '2001-05-08' Street: maxLength: 50 type: string example: 'Weiße Breite 5' PostalCode: maxLength: 10 type: string example: '49084' City: maxLength: 40 type: string example: Osnabrück CountryCode: type: string example: DE x-tags: - infoservice x-tags: - infoservice x-tags: - infoservice '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '422': description: 'Unprocessable Entity' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: info sValue: 'OpenApi check failed (code AWX494)' sData: '' '500': description: 'internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' /infoservice/schufa/score/creditcheck/: post: tags: - infoservice summary: 'Schufa Score CreditCheck' operationId: schufaScoreCreditCheck parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar requestBody: content: application/json: schema: required: - Order - Person - Address type: object properties: Order: allOf: - type: object properties: CustomerReference: maxLength: 40 type: string ProofOfInterest: enum: - 1 - 2 - 3 - 4 type: integer x-enumNames: - Kreditanfrage - Geschäftsanbahnung - Bonitätsprüfung - Forderung ReportFormat: enum: - NONE - PDF type: string IdentCheckVariant: enum: - Standard - Jugendschutz - Premium type: string RequestFeatureCode: maxLength: 2 type: string x-tags: - infoservice - required: - RequestFeatureCode type: object example: CustomerReference: 6910-2 RequestFeatureCode: AV Person: allOf: - type: object properties: Title: maxLength: 30 type: string example: 'Prof. Dr.' FirstName: maxLength: 40 type: string example: Max LastName: maxLength: 40 type: string example: Mustermann Gender: enum: - u - m - w - f type: string example: m x-enumNames: - unknown - male - female - female BirthDate: type: string format: date example: '2001-05-08' BirthPlace: maxLength: 24 type: string example: '' x-tags: - infoservice - required: - FirstName - LastName - Gender type: object Address: required: - Street - HouseNumber - PostalCode - City - CountryCode type: object properties: Street: maxLength: 40 type: string example: 'Weiße Breite' HouseNumber: maxLength: 10 type: string example: 5-7 PostalCode: maxLength: 10 type: string example: '49084' City: maxLength: 40 type: string example: Osnabrück CountryCode: enum: - DE type: string example: DE x-tags: - infoservice x-tags: - infoservice responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: Response: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Operation successful' x-tags: - infoservice description: 'array of Messages' sRaw: type: string example: '...' x-tags: - infoservice Data: type: object properties: ServiceReference: type: string example: '3522258114' CustomerReference: maxLength: 40 type: string example: 6910-2 ScoreCard: type: object properties: ScoreValue: type: integer example: 822 RiskQuote: type: string example: '0,35' ScoreArea: maxLength: 1 type: string example: A ScoreText: maxLength: 255 type: string example: 'INKASSO A, INKASSO INDEX 273' x-tags: - infoservice x-tags: - infoservice x-tags: - infoservice '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '422': description: 'Unprocessable Entity' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: info sValue: 'OpenApi check failed (code AWX494)' sData: '' '500': description: 'internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' /collect/claim/new/: put: tags: - collect summary: 'Übergabe neue Forderung' operationId: delegate parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar requestBody: content: application/json: schema: required: - ClientCustomerRefNo - Debtor - Claim type: object properties: ClientCustomerRefNo: maxLength: 40 type: string example: 6910-2 PartnerNo: type: integer example: 91 AcceptanceDate: type: string format: date-time example: '2022-10-17T12:15:00' deprecated: true Stage: enum: - V type: string example: V x-enumNames: - Vorgerichtlich Debtor: required: - Company - PersonType - LastName - FirstName - PostalAddress - Communications type: object properties: LegalForm: enum: - AG - Einzelunternehmen - e.G. - e.K. - e.V. - GbR - GmbH - 'GmbH & Co KG' - Inc. - KG - KdöR - Ltd. - OHG - Stiftung - UG - 'UG & Co. KG' type: string example: GmbH x-enumNames: - Aktiengesellschaft - Einzelunternehmen - 'Eingetragene Genossenschaft' - 'Eingetragener Kaufmann' - 'Eingetragener Verein' - 'Gesellschaft bürgerlichen Rechts' - 'Gesellschaft mit beschränkter Haftung' - 'Gesellschaft mit beschränkter Haftung & Compagnie Kommanditgesellschaft' - 'Incorporated (us)' - Kommanditgesellschaft - 'Körperschaft des öffentlichen Rechts' - 'Limited Company (britisch)' - 'Offene Handelsgesellschaft' - Stiftung - 'Unternehmergesellschaft (haftungsbeschränkt)' - 'Unternehmergesellschaft (haftungsbeschränkt) & Compagnie Kommanditgesellschaft' Company: maxLength: 60 type: string example: '' PersonType: enum: - 0 - 1 - 2 type: integer example: 1 x-enumNames: - Unbekannt - Herr - Frau LastName: maxLength: 60 type: string example: Mustermann FirstName: maxLength: 40 type: string example: Max BirthDate: type: string format: date example: '2001-05-08' PostalAddress: allOf: - required: - Street - PostalCode - City - CountryCode - Validity type: object properties: Annex: maxLength: 120 type: string Street: maxLength: 50 minLength: 3 type: string PostalCode: maxLength: 10 minLength: 3 type: string City: maxLength: 50 minLength: 3 type: string CountryCode: enum: - EG - GQ - ET - AF - AX - AL - DZ - AD - AO - AI - AQ - AG - AR - AM - AW - AZ - AU - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CL - CN - CK - CR - CI - CW - DK - DE - DM - DO - DJ - EC - SV - ER - EE - SZ - FO - FK - FJ - FI - FR - TF - GF - PF - GA - GM - GE - GH - GI - GD - GR - GL - GB - GP - GU - GT - GG - GN - GW - GY - HT - HM - HN - HK - IN - ID - IQ - IR - IE - IS - IL - IT - JM - JP - YE - JE - JO - VG - VI - KY - KH - CM - CA - CV - KZ - QA - KE - KG - KI - CC - CO - KM - CG - CD - KP - KR - XK - HR - CU - KW - LA - LS - LV - LB - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - IM - MP - MA - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MZ - MM - NA - NR - NP - NC - NZ - NI - NL - NE - NG - NU - NF - 'NO' - AT - OM - PK - PS - PW - PA - PG - PY - PE - PH - PN - PL - PT - PR - MK - RE - RW - RO - RU - BL - MF - SB - ZM - AS - WS - SM - ST - SA - SE - CH - SN - RS - SC - SL - ZW - SG - SK - SI - SO - ES - SJ - LK - SX - VC - SH - KN - LC - PM - SD - ZA - GS - SS - SR - SY - TJ - TW - TZ - TH - TL - TG - TK - TO - TT - TD - CZ - TR - TN - TM - TC - TV - UG - UA - HU - UY - UM - US - UZ - VU - VA - VE - AE - VN - WF - CX - EH - CF - CY type: string Validity: type: integer - type: object example: Annex: '' Street: 'Weiße Breite 5' PostalCode: '49084' City: Osnabrück CountryCode: DE Validity: 1 AlternateAddress: allOf: - required: - Street - PostalCode - City - CountryCode - Validity type: object properties: Annex: maxLength: 120 type: string Street: maxLength: 50 minLength: 3 type: string PostalCode: maxLength: 10 minLength: 3 type: string City: maxLength: 50 minLength: 3 type: string CountryCode: enum: - EG - GQ - ET - AF - AX - AL - DZ - AD - AO - AI - AQ - AG - AR - AM - AW - AZ - AU - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - CL - CN - CK - CR - CI - CW - DK - DE - DM - DO - DJ - EC - SV - ER - EE - SZ - FO - FK - FJ - FI - FR - TF - GF - PF - GA - GM - GE - GH - GI - GD - GR - GL - GB - GP - GU - GT - GG - GN - GW - GY - HT - HM - HN - HK - IN - ID - IQ - IR - IE - IS - IL - IT - JM - JP - YE - JE - JO - VG - VI - KY - KH - CM - CA - CV - KZ - QA - KE - KG - KI - CC - CO - KM - CG - CD - KP - KR - XK - HR - CU - KW - LA - LS - LV - LB - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - IM - MP - MA - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MZ - MM - NA - NR - NP - NC - NZ - NI - NL - NE - NG - NU - NF - 'NO' - AT - OM - PK - PS - PW - PA - PG - PY - PE - PH - PN - PL - PT - PR - MK - RE - RW - RO - RU - BL - MF - SB - ZM - AS - WS - SM - ST - SA - SE - CH - SN - RS - SC - SL - ZW - SG - SK - SI - SO - ES - SJ - LK - SX - VC - SH - KN - LC - PM - SD - ZA - GS - SS - SR - SY - TJ - TW - TZ - TH - TL - TG - TK - TO - TT - TD - CZ - TR - TN - TM - TC - TV - UG - UA - HU - UY - UM - US - UZ - VU - VA - VE - AE - VN - WF - CX - EH - CF - CY type: string Validity: type: integer - type: object example: Annex: 'Bei Schmidt' Street: 'Lieferstrasse 1' PostalCode: '49084' City: Osnabrück CountryCode: DE Validity: 1 Communications: type: array items: required: - Means - Type - Value - Validity type: object properties: Means: enum: - 1 - 2 - 3 - 4 - 5 type: integer example: 2 x-enumNames: - E-Mail - Telephone - 'Mobile Phone' - Fax - Website Type: enum: - 1 - 2 type: integer example: 2 x-enumNames: - privat - dienstlich Value: maxLength: 60 type: string example: '0541 2029-0' Validity: type: integer example: 1 Claim: required: - Amount - ContractDate - ContractualItemCatalogueNo - ContractualCondition - Reason - PrincipalClaim - DunningCosts type: object properties: Amount: type: number example: 79.99 ContractDate: type: string format: date example: '2022-01-06' ContractualItemCatalogueNo: enum: - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '60' - '61' - '62' - '63' - '64' - '65' - '66' - '67' - '68' - '69' - '70' - '71' - '72' - '73' - '74' - '75' - '76' - '77' - '78' - '79' - '80' - '81' - '82' - '83' - '84' - '90' - '95' - '98' type: string x-enumNames: - 'Anzeigen in Zeitungen u.a.' - 'Ärztliche oder zahnärztliche Leistung' - Bürgschaft - Darlehensrückzahlung - Dienstleistungsvertrag - Frachtkosten - 'Geschäftsbesorgung durch Selbständige' - Handwerkerleistung - Heimunterbringung - Hotelkosten - Kaufvertrag - Kontokorrentabrechnung - 'Krankenhauskosten - Pflege/Behandlung -' - Lagerkosten - Leasing/Mietkauf - Lehrgangs-/Unterrichtskosten - 'Miete für Geschäftsraum einschl. Nebenkosten' - 'Miete für Kraftfahrzeug' - 'Miete für Wohnraum einschl. Nebenkosten' - 'Mietnebenkosten - auch Renovierungskosten -' - Miete - Mitgliedsbeitrag - Pacht - Rechtsanwalts-/Rechtsbeistandshonorar - Rentenrückstände - Reparaturleistung - 'Rückgriff aus Versicherungsvertrag wegen Unfall/Vorfall' - 'Schadenersatz aus Vertrag' - 'Schadenersatz aus Unfall/Vorfall' - Scheck/Wechsel - 'Scheck-/Wechselprovision (1/3 %)' - 'Scheck-/Wechselunkosten - Spesen/Protest -' - Schuldanerkenntnis - Speditionskosten - Tilgungs-/Zinsraten - 'Überziehung des Bankkontos' - 'Ungerechtfertigte Bereicherung' - Unterhaltsrückstände - 'Vergleich, außergerichtlicher' - Vermittlungs-/Maklerprovision - Versicherungsprämie/-beitrag - 'Versorgungsleistung - Strom, Wasser, Gas, Wärme -' - Warenlieferung/-en - Werkvertrag/Werklieferungsvertrag - Zeitungs-/Zeitschriftenbezug - Zinsrückstände/Verzugszinsen - 'Nicht eingehaltene Abnahmeverpflichtung/en' - 'Fahrgeld/erhöhtes Beförderungsentgelt für eine Fahrt ohne gültigen Fahrausweis' - 'Erhöhtes Beförderungsentgelt für eine Fahrt ohne gültigen Fahrausweis' - 'Inkassokosten für außergerichtlichen Vergleich/Abzahlungsvereinbarung' - 'Geschäftsgebühr gemäß § 40 VVG' - 'Rückzahlung von Handelsvertreterprovisionen' - 'Zahlung kassierter und nicht abgeführter Inkassogelder' - 'Unerlaubte Nutzung urheberrechtlich geschützter Werke aus dem Repertoire des Antragstellers' - 'Gesetzlicher Vergütungsanspruch nach § 27 UrhG' - 'Fällige Pauschale für die Einräumung urheberrechtlicher Nutzungsrechte' - 'Rückzahlung des Familiengründungsdarlehen' - Versorgungsleistung - 'Wahlleistungen bei stationärer Behandlung' - 'Folgebeitrag zur Versicherung' - 'Zwischenbeitrag zur Versicherung' - 'Beitrag laut Versicherungsschein' - 'Nachtrag zur Versicherung' - 'Beitragsrückstand zur Versicherung' - 'Scheckrücklauf zur Versicherung' - 'Restforderung abzüglich Gutschriften' - 'Entgeltforderung gemäß Telekom-Rechnung' - Kindertagesstättenbeitrag - 'Verzugsschaden (nicht anrechenbare RA-Kosten aus vorgerichtl. Tätigkeit)' - 'Rückzahlung aus grundpf. gesichertem Kreditvertrag/gleichgestelltem Darlehen n. Bausparkassengesetz' - 'Gesetzlicher Vergütungsanspruch nach § 54 UrhG' - Kreditkartenvertrag - Reisevertrag - Telekommunikationsleistungen - Krankentransportkosten - 'Tierärztliche Leistung' - Verpflegungskosten - 'Rückgriff aus Bürgschaft oder Garantie' - 'Entschädigung des Sortenschutzinhabers für Nachbau' - 'Prämienzuschlag für Krankheitskostenversicherung wegen Nichtversicherung gemäß § 193 Abs. 4 VVG' - 'Prämienrückstand für Krankheitskostenversicherung gem. § 193 Abs. 6 VVG' - 'Säumniszuschlag für Prämienrückstand zur Krankheitskostenversicherung gem. § 193 Abs. 6 VVG' - 'Wohngeld/Hausgeld für Wohnungseigentümergemeinschaft' - 'Beiträge zur privaten Pflegeversicherung' - 'Warenlieferung per Vorkasse' ContractualCondition: enum: - 1 - 2 - 3 type: integer x-enumNames: - 'Forderungen über verkaufte Waren' - 'Forderung über erbrachte Leistungen' - 'Forderungen über per Vorkasse verkaufte Waren' OriginalCreatorName: maxLength: 100 type: string example: 'tatsächlicher Gläubigername' Reason: maxLength: 200 type: string example: Nutzungsgebühr PrincipalClaim: required: - Number - Value - Date type: object properties: Number: maxLength: 40 type: string example: '1086247' Value: type: number example: 79.99 Date: type: string format: date example: '2021-08-02' Remark: maxLength: 200 type: string example: 'Bemerkung zur Rechnung' DunningCosts: required: - Number - Value - Date type: object properties: Number: maxLength: 40 type: string example: '1086247' Value: type: number example: 79.99 Date: type: string format: date example: '2021-08-02' Remark: maxLength: 200 type: string example: 'Bemerkung zur Rechnung' Memo: maxLength: 200 type: string example: 'Nutzungsgebühr für den Monat Oktober 2022' responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: Response: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Request successfully received' description: 'array of Messages' Data: type: object properties: Filenumber: maxLength: 11 type: string example: '66842321091' '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '422': description: 'Unprocessable Entity' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: info sValue: 'OpenApi check failed (code AWX494)' sData: '' '500': description: 'internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' '/collect/claim/{az}/payment/': post: tags: - collect summary: 'Zahlungseingang zu einer Forderung melden' operationId: collectClaimDirectPayment parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar - name: az in: path description: FileNumber required: true schema: pattern: '^\d{11}$' type: string example: '12345678910' requestBody: content: application/json: schema: required: - Amount - AcceptanceDate type: object properties: Amount: type: number example: 79.99 AcceptanceDate: type: string format: date example: '2022-10-17' VoucherNo: maxLength: 50 type: string example: B707955 Notice: maxLength: 200 type: string example: 'Direktzahlung an Gläubiger vor Übernahme' responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Request successfully received' description: 'array of Messages' '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '500': description: 'Internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' '/collect/claim/{az}/close/': post: tags: - collect summary: 'Inkasso Forderung stornieren' operationId: claimClose parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar - name: az in: path description: FileNumber required: true schema: pattern: '^\d{11}$' type: string example: '12345678910' responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Request successfully received' description: 'array of Messages' '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: Response: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '500': description: 'internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' '/collect/claim/{az}/status/': get: tags: - collect summary: 'Status einer Inkasso Forderung' operationId: claimStatus parameters: - name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 - name: user in: header description: authentification required: true schema: type: string example: foo - name: password in: header description: authentification required: true schema: type: string example: bar - name: az in: path description: FileNumber required: true schema: pattern: '^\d{11}$' type: string example: '12345678910' responses: '200': description: 'successful operation' content: application/json: schema: type: object properties: Response: type: object properties: bSuccess: type: boolean example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Request successfully received' description: 'array of Messages' Data: type: object properties: ClientCustomerRefNo: maxLength: 40 type: string example: 6910-2 ImportStatus: enum: - succeeded - pending - failed type: string example: succeeded Stage: enum: - V - G - L - 'N' - Ü - n.a. type: string example: V x-enumNames: - Vorgerichtlich - Gerichtlich - 'Langzeitüberwachung vorgerichtlich' - Nachgerichtlich - 'Nachgerichtliche Überwachung' - 'nicht verfügbar' Reason: type: object properties: Notice: type: string example: Teilzahlung ClosingDate: type: string format: date example: '2022-10-17' '400': description: 'bad request' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Request method invalid. (code SFL327)' sData: '' '401': description: Unauthorized content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'CDM: Access denied (code BQW124)' sData: '' '404': description: 'not found' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - sKey: error sValue: 'Not Found' sData: '' '500': description: 'internal server error' content: { } '503': description: 'Service Unavailable' content: application/json: schema: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse example: bSuccess: false aMessage: - skey: info sValue: 'Service not available' - skey: error sValue: 'Service error (code ZFB826)' - skey: logId sValue: 63fdbb601e651 sData: '' text/html: schema: type: string example: '503 Service Unavailable

Service Unavailable

The server is temporarily unable to service your request due to maintenance downtime or capacity problems. Please try again later.

' components: schemas: apiResponse: type: object properties: bSuccess: type: boolean description: 'operation successful true/false' example: true aMessage: type: array items: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage description: 'array of Messages' sData: type: string description: JSON example: '{"foo":"bar"}' x-type: apiResponse apiMessage: type: object properties: sKey: type: string example: info sValue: type: string example: 'Claim successfully received' x-type: apiMessage parameters: parameter_uuid: name: uuid in: header description: 'UUID of client' required: true schema: maxLength: 36 type: string example: 12345678-1234-1234-1234-123456789012 parameter_user: name: user in: header description: authentification required: true schema: type: string example: foo parameter_password: name: password in: header description: authentification required: true schema: type: string example: bar tags: - name: collect description: Inkasso externalDocs: description: 'Weiterführende Dokumentation' url: /docs/v2.2/ - name: infoservice description: Auskünfte externalDocs: description: 'Weiterführende Dokumentation' url: /docs/v2.2/ externalDocs: description: 'mediaFinanz API Dokumentation' url: /