Read more about our API and how to connect on docs.inyett.com
contact: email: support@inyett.com version: '2.0' servers: [] security: - X-Api-Key: [] - Bearer: [] tags: - name: Inyett Company Control description: >- Risk assessment endpoints such as main rating, fraud, debt and payment remark checks, used to screen a company before paying it. - name: Inyett Company Data description: >- Company master data: addresses, accounts, owners, directors, financial statements and other registry information for a company. - name: Inyett Company Find description: Free-text and organisation-number search for companies. - name: Inyett Company Monitor description: >- Continuous monitoring of company portfolios: create portfolios, add or remove companies to watch, and read back detected changes over time. - name: Inyett Payment Control description: >- Batch screening of outgoing payments: submit a payment batch for analysis and read back any warnings before the money leaves the customer. paths: /2/{profileCountry}/payment-control/batches: post: tags: - Inyett Payment Control summary: Create batch description: >- Submits a batch of outgoing payment transactions for screening. Returns immediately once the batch is queued; poll the batch warnings endpoint with the same externalId to read the analysis result. operationId: paymentControlBatchesCreateBatch parameters: - name: profileCountry in: path description: Country for profile required: true schema: $ref: '#/components/schemas/Country' - name: AppId in: header description: App id schema: type: string requestBody: description: Batch content: application/json: schema: $ref: '#/components/schemas/BatchCreateBody' text/json: schema: $ref: '#/components/schemas/BatchCreateBody' application/*+json: schema: $ref: '#/components/schemas/BatchCreateBody' responses: '200': description: OK '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ValidationProblemDetails' application/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' text/json: schema: $ref: '#/components/schemas/ValidationProblemDetails' '401': description: Unauthorized content: text/plain: schema: $ref: '#/components/schemas/ProblemDetails' application/json: schema: $ref: '#/components/schemas/ProblemDetails' text/json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/FailResponse' application/json: schema: $ref: '#/components/schemas/FailResponse' text/json: schema: $ref: '#/components/schemas/FailResponse' '500': description: Internal Server Error content: text/plain: schema: $ref: '#/components/schemas/FailResponse' application/json: schema: $ref: '#/components/schemas/FailResponse' text/json: schema: $ref: '#/components/schemas/FailResponse' components: schemas: Country: enum: - SE - 'NO' type: string description: >- ISO country code supported for company lookups: SE (Sweden) or NO (Norway). BatchCreateBody: required: - externalId type: object properties: externalId: minLength: 1 type: string debtorAccount: type: string nullable: true transactions: type: array items: $ref: '#/components/schemas/BatchTransactionCreateBody' nullable: true additionalProperties: false description: >- Request body for submitting a new payment batch for screening, containing the debtor account and its transactions. ValidationProblemDetails: 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 errors: type: object additionalProperties: type: array items: type: string nullable: true additionalProperties: {} description: >- A machine-readable validation error response (RFC 7807 Problem Details) including per-field error messages. 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: {} description: >- A machine-readable error response following the RFC 7807 Problem Details format. FailResponse: type: object properties: message: type: string nullable: true additionalProperties: false description: >- Error response returned when a request fails, containing a human-readable message. BatchTransactionCreateBody: required: - amount - creditorAccount - creditorAccountType - currency - externalId - paymentDate type: object properties: paymentDate: type: string format: date-time amount: type: number description: Decimal with . separator format: double currency: minLength: 1 type: string description: 3 letter currency format. SEK, NOK etc creditorOrgNr: type: string nullable: true creditorName: maxLength: 200 type: string description: The name of the creditor. Maximum length is 200 characters. nullable: true ocr: type: string description: OCR number nullable: true verNr: type: string nullable: true invoiceNr: type: string nullable: true creditorAccountType: minLength: 1 type: string description: Account type (PGNR,BGNR, BANK, IBAN, CASH ) creditorAccount: minLength: 1 type: string description: Account number externalId: minLength: 1 type: string additionalProperties: false description: A single outgoing payment transaction within a submitted payment batch. securitySchemes: X-Api-Key: type: apiKey description: 'Api key needed to access the endpoints. X-Api-Key: My api key' name: X-Api-Key in: header Bearer: type: http description: Please enter a valid token scheme: Bearer bearerFormat: JWT ````