> ## Documentation Index > Fetch the complete documentation index at: https://docs.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Test a value against fraud-control rules > Checks whether a `list_type` and `value` match an existing fraud-control rule without creating or changing any fraud-control rules. Returns whether the value is blacklisted, whitelisted, or not listed. ## OpenAPI ````yaml /api-reference/management.json post /v2/blocks/test openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. ## Updating a resource `PUT` merges. A field you omit from the body is left at its stored value, so you do not need to read a resource and send it back whole in order to change one field. This is a deliberate departure from the HTTP convention that `PUT` replaces, and it holds across this API. Two qualifications, both visible on each operation's own request schema: - Some operations mark fields `required` in their request schema. Those must be sent on every request, whether or not you are changing them. - A field that holds a list or a map is replaced, not merged, when you supply it. Sending one entry of a collection stores that entry and drops the rest, so to change one member of a collection you must send the collection's other members alongside it. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Batch Jobs (Legacy) - name: Blocks - name: Campaigns - name: Components - name: Components Operations - name: Domains - name: Email - name: Erasure - name: Event Streams - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: SFTP Servers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v2/blocks/test: post: tags: - Blocks summary: Test a value against fraud-control rules description: >- Checks whether a `list_type` and `value` match an existing fraud-control rule without creating or changing any fraud-control rules. Returns whether the value is blacklisted, whitelisted, or not listed. requestBody: content: application/json: example: list_type: CIDR value: value schema: $ref: '#/components/schemas/BlockCheckRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/BlockCheckResponse' description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' block_duplicate: $ref: '#/components/examples/block_duplicate' block_value_invalid: $ref: '#/components/examples/block_value_invalid' invalid_incoming_url: $ref: '#/components/examples/invalid_incoming_url' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' invalid_uri_in_json: $ref: '#/components/examples/invalid_uri_in_json' invalid_uri_in_query_parameter: $ref: '#/components/examples/invalid_uri_in_query_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: BlockCheckRequest: description: >- Body of a `POST /v2/blocks/test` request. Checks a value against existing fraud-control rules without creating one. properties: list_type: description: >- What the fraud-control rule matches. USER_AGENT matches a substring of the event user-agent header (regex is not supported). EMAIL_DOMAIN matches the profile email domain on the event (for example example.com). NORMALIZED_EMAIL matches the provider-normalized profile email. Whether plus-address variants of the same mailbox match depends on the email provider. CIDR matches the event IP with CIDR notation (for example 192.168.1.0/24); overlapping CIDRs are separate fraud-control rules, not duplicates. enum: - CIDR - EMAIL_DOMAIN - NORMALIZED_EMAIL - USER_AGENT type: string value: description: >- Value to test against existing fraud-control rules. The value is lowercased but not provider-normalized, so for NORMALIZED_EMAIL send the provider-normalized email, as stored on the fraud-control rule. type: string required: - list_type - value type: object BlockCheckResponse: description: Result of testing a value against fraud-control rules. properties: block_Id: description: Identifier of the matching fraud-control rule, when one matched. nullable: true type: string result: description: >- Outcome of testing a value against fraud-control rules. BLACKLISTED means a BLACK fraud-control rule matched. WHITELISTED means a WHITE fraud-control rule matched. NOT_LISTED means no fraud-control rule matched. A USER_AGENT value shorter than five characters returns BLACKLISTED with no `block_Id`, whether or not a fraud-control rule matches it. enum: - BLACKLISTED - NOT_LISTED - WHITELISTED type: string required: - block_Id - result type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object examples: binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 block_duplicate: summary: block_duplicate value: code: block_duplicate http_status_code: 400 message: >- A fraud-control rule with this filter type, list type, and value already exists parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 block_value_invalid: summary: block_value_invalid value: code: block_value_invalid http_status_code: 400 message: Normalized email block email address is not valid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_incoming_url: summary: invalid_incoming_url value: code: invalid_incoming_url http_status_code: 400 message: Incoming URL is an invalid URI parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_uri_in_json: summary: invalid_uri_in_json value: code: invalid_uri_in_json http_status_code: 400 message: Invalid URI in JSON parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_uri_in_query_parameter: summary: invalid_uri_in_query_parameter value: code: invalid_uri_in_query_parameter http_status_code: 400 message: Invalid URI in query parameter parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ```` ## Related topics - [Create a fraud-control rule](https://docs.extole.com/api-reference/blocks/create-a-fraud-control-rule.md) - [Delete a fraud-control rule](https://docs.extole.com/api-reference/blocks/delete-a-fraud-control-rule.md) - [Get a fraud-control rule](https://docs.extole.com/api-reference/blocks/get-a-fraud-control-rule.md) - [List fraud-control rules](https://docs.extole.com/api-reference/blocks/list-fraud-control-rules.md) - [List global fraud-control rules](https://docs.extole.com/api-reference/blocks/list-global-fraud-control-rules.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.