---
updatedAt: 2025-08-26T13:29:37.000Z
agentTools:
  projectIndex: https://apiclub.readme.io/llms.txt
---

# Name Compare API

The Name Compare API verifies the documents provided to you by comparing names across multiple documents and forms and ensuring whether it's the required individual or not.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "uat-url",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://uat.apiclub.in/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/compare_name": {
      "post": {
        "summary": "Name Compare API",
        "description": "The Name Compare API verifies the documents provided to you by comparing names across multiple documents and forms and ensuring whether it's the required individual or not.",
        "operationId": "name-compare-api",
        "parameters": [
          {
            "name": "x-request-id",
            "in": "header",
            "description": "Optional, custom Request ID min 5 and max 50 characters",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name1",
                  "name2"
                ],
                "properties": {
                  "name1": {
                    "type": "string",
                    "description": "Name"
                  },
                  "name2": {
                    "type": "string",
                    "description": "Name"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "success": {
                    "value": "{\n  \"code\": 200,\n  \"status\": \"success\",\n  \"message\": \"Success\",\n  \"request_id\": \"\",\n  \"response\": {\n    \"request_id\": \"test\",\n    \"match_score\": \"92.31\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "integer",
                      "example": 200,
                      "default": 0
                    },
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "message": {
                      "type": "string",
                      "example": "Success"
                    },
                    "request_id": {
                      "type": "string",
                      "example": ""
                    },
                    "response": {
                      "type": "object",
                      "properties": {
                        "request_id": {
                          "type": "string",
                          "example": "test"
                        },
                        "match_score": {
                          "type": "string",
                          "example": "92.31"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Referer",
        "value": "docs.apiclub.in"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```