> ## Documentation Index > Fetch the complete documentation index at: https://docs.godiligent.ai/llms.txt > Use this file to discover all available pages before exploring further. # Block Company > Block company by various data points ## OpenAPI ````yaml POST /blocked-companies openapi: 3.0.1 info: version: 1.5.0 title: Diligent description: > Download Postman collection [here](https://docs.godiligent.ai/files/postman_collection.json). servers: - url: https://api.godiligent.ai description: Production - url: https://api.sandbox.godiligent.ai description: Sandbox security: - xApiKey: [] tags: - name: CDD description: Customer Due Diligence - name: Company description: Company Information - name: Blocked Companies description: Manage blocked companies - name: Monitorings description: Website monitoring and alerts for changes and risks - name: Webhooks description: > ## How to Secure Webhook Deliveries To ensure that webhook payloads are securely transmitted and verified. This guide explains how to configure and validate webhook deliveries using a shared secret. ### How It Works When setting up a webhook, a secret is configured on both the sender (our system) and the receiver (your endpoint). Each webhook payload is signed using this secret, allowing the receiver to verify its authenticity. #### Step 1: Configuring Your Webhook Secret 1. When creating a webhook in our system, specify a unique secret key. This secret should be a strong, randomly generated string. 2. Store this secret securely on your server; it should never be exposed publicly. #### Step 2: Receiving Webhook Payloads When your server receives a webhook event, the request will include an `X-Signature` header containing a HMAC signature of the payload. Example header: ``` X-Signature: sha256=abcdef1234567890... ``` #### Step 3: Validating the Webhook Signature To verify the webhook payload: 1. Retrieve the `X-Signature` value from the request headers. 2. Compute the HMAC SHA-256 signature of the request payload using your webhook secret. 3. Compare the computed signature with the one in the `X-Signature` header. 4. If they match, the webhook is valid. #### (Python) ```python import hashlib import hmac import json def verify_webhook_signature(secret, payload, signature): computed_signature = hmac.new(secret.encode(), payload.encode(), hashlib.sha256).hexdigest() expected_signature = f"sha256={computed_signature}" return hmac.compare_digest(expected_signature, signature) # Example usage: secret = "your_webhook_secret" payload = json.dumps({"event": "example"}) received_signature = "sha256=abcdef1234567890..." if verify_webhook_signature(secret, payload, received_signature): print("Valid webhook received!") else: print("Invalid webhook signature!") ``` #### (JavaScript) ```javascript const crypto = require('crypto'); function verifyWebhookSignature (secret, payload, signature) { const computedSignature = `sha256=${crypto.createHmac('sha256', secret) .update(payload) .digest('hex')}`; return crypto.timingSafeEqual(Buffer.from(computedSignature), Buffer.from(signature)); } // Example usage: const secret = "your_webhook_secret"; const payload = JSON.stringify({ event: "example" }); const receivedSignature = "sha256=abcdef1234567890..."; if (verifyWebhookSignature(secret, payload, receivedSignature)) { console.log("Valid webhook received!"); } else { console.log("Invalid webhook signature!"); } ``` #### Security Considerations - Always use HTTPS to prevent interception of webhook payloads. - Reject webhook requests that fail signature validation. - Rotate secrets periodically to enhance security. By following this guide, you ensure that webhook deliveries are secure and trusted. - name: Instant Screening (experimental) description: Instant Website Screening API - name: Name Screening description: Name screening search, alert management and remediation paths: /blocked-companies: post: tags: - Company summary: Block company description: Block company by various data points requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/CompanyBlockWebsite' - $ref: '#/components/schemas/CompanyBlockLegalNameAddress' - $ref: >- #/components/schemas/CompanyBlockRegisterNumberAndCountryCode required: true responses: '200': description: Successfully blocked company, returns the created record content: application/json: schema: $ref: '#/components/schemas/BlockedCompany' '400': description: Bad Request content: application/json: schema: type: array items: $ref: '#/components/schemas/ValidationError' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '500': description: Internal Server Error components: schemas: CompanyBlockWebsite: type: object required: - website - reason properties: website: type: string description: The website of the business example: example.com email: type: string description: The email of the business example: fulan@domain.com legal_name: type: string description: The legal name of the business example: PayLane ltd address: type: string description: The address of the business, or partial address example: 123 Imaginary St, 45678 Fictional City external_id: type: string description: Reference to be used in the customer's system example: abc123 - my customer reference vat_number: type: string description: The VAT number of the business example: BE09999999XX register_number: type: string description: The register number of the business example: '123546' reason: type: string description: The reason for blocking the company example: Fraudulent activity notes: type: string description: Additional notes for blocking the company example: Company engaged in fraudulent activity CompanyBlockLegalNameAddress: type: object required: - legal_name - address - reason properties: website: type: string description: The website of the business example: example.com email: type: string description: The email of the business example: fulan@domain.com legal_name: type: string description: The legal name of the business example: PayLane ltd address: type: string description: The address of the business, or partial address example: 123 Imaginary St, 45678 Fictional City external_id: type: string description: Reference to be used in the customer's system example: abc123 - my customer reference vat_number: type: string description: The VAT number of the business example: BE09999999XX register_number: type: string description: >- The registry number of the business (i.e. company house number, SIRET, SIREN, P.IVA, only GB, FR and IT companies are supported) example: '12345678' reason: type: string description: The reason for blocking the company example: Fraudulent activity notes: type: string description: Additional notes for blocking the company example: Company engaged in fraudulent activity CompanyBlockRegisterNumberAndCountryCode: type: object required: - register_number - country_code properties: website: type: string description: The website of the business example: example.com email: type: string description: The email of the business example: fulan@domain.com legal_name: type: string description: The legal name of the business example: PayLane ltd address: type: string description: The address of the business, or partial address example: 123 Imaginary St, 45678 Fictional City external_id: type: string description: Reference to be used in the customer's system example: abc123 - my customer reference vat_number: type: string description: The VAT number of the business example: BE09999999XX register_number: type: string description: >- The registry number of the business (i.e. company house number, SIRET, SIREN, P.IVA, only GB, FR and IT companies are supported) example: '12345678' reason: type: string description: The reason for blocking the company example: Fraudulent activity notes: type: string description: Additional notes for blocking the company example: Company engaged in fraudulent activity BlockedCompany: type: object required: - id - reason - blocked_at properties: id: type: string description: Unique identifier for the blocked company record example: bc-a91a8416-0a38 website: type: string description: The website of the business (if provided) nullable: true example: example.com email: type: string description: The email of the business (if provided) nullable: true example: contact@example.com legal_name: type: string description: The legal name of the business (if provided) nullable: true example: Example Company Ltd address: type: string description: The address of the business (if provided) nullable: true example: 123 Example Street, City country_code: type: string description: Country code in ISO 3166-1 alpha-2 format (if provided) nullable: true example: DE vat_number: type: string description: The VAT number of the business (if provided) nullable: true example: BE09999999XX register_number: type: string description: The registry number of the business (if provided) nullable: true example: '123456789' reason: type: string description: The reason for blocking the company example: Fraudulent activity notes: type: string description: Additional notes about the block nullable: true example: Multiple reports of fraud from customers blocked_at: type: string format: date-time description: When the company was blocked example: '2025-01-15T12:30:45Z' external_id: type: string description: Reference ID from the customer's system (if provided) nullable: true example: cust-12345 ValidationError: type: object properties: errors: type: array items: $ref: '#/components/schemas/ValidationErrorItem' required: - errors ValidationErrorItem: type: object properties: path: type: array items: type: string description: JSON path to the field with the error message: type: string description: Error message code: type: string description: Error code indicating the type of error required: - path - message - code securitySchemes: xApiKey: type: apiKey name: X-API-KEY in: header ````