---
updatedAt: 2026-05-29T13:25:42.000Z
agentTools:
  projectIndex: https://developer.eftcorp.com/llms.txt
---

# Get the ratify results for the customer

The results are returned from most recent to oldest so pass offset=0 and limit=1 for the most recent one

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://eclipse-java-sandbox.ukheshe.rocks",
      "description": "Eclipse sandbox environment"
    },
    {
      "url": "https://ukheshe.live",
      "description": "Eclipse production environment"
    },
    {
      "url": "https://eclipse-java-develop.ukheshe.rocks",
      "description": "Eclipse development environment"
    },
    {
      "url": "https://zw.ukheshe.live",
      "description": "Zim Eclipse production environment"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "Avp": {
        "description": "An attribute/value pair for providing weakly typed data on various messages",
        "type": "object",
        "required": [
          "att",
          "val"
        ],
        "properties": {
          "att": {
            "type": "string",
            "pattern": "\\S"
          },
          "val": {
            "type": "string"
          }
        }
      },
      "EclipseKycResult": {
        "type": "object",
        "description": "The result of a ratify test against a customer",
        "properties": {
          "accountableInstitutionBlacklist": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "additionalIdentityNumberMatchesBackOfAdditionalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "addressMatchesProofOfAddress": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "adultLastNameMatchesMinorLastName": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "adverseMediaCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "asylumPaperIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "asylumPaperRefNumberMatchesAsylumPaper": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "backOfNationalIdentityIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "backOfdriversLicenseIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "bankStatementIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "birthCertificateIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "cardNumberMatchesNationalDatabase": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "cbgSanctionsScreeningCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "creditBureauCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "customListKycCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "dateOfBirthMatcheForeignCertificate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "dateOfBirthMatchesAsylumPaper": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "dateOfBirthMatchesBackOfDriversLicence": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "dateOfBirthMatchesBackOfNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "dateOfBirthMatchesDriversLicence": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "dateOfBirthMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "dateOfBirthMatchesPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "dateOfBirthMatchesTemporaryIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "driversLicenseIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "euCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "ficCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "firstNameMatchesAsylumPaper": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "firstNameMatchesBackOfAdditionalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "firstNameMatchesBirthCertificate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "firstNameMatchesDriversLicence": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "firstNameMatchesForeignCertificate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "firstNameMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "firstNameMatchesPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "firstNameMatchesTaxDocument": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "firstNameMatchesTemporaryIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "frenchListCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "idNumberMatchesBackOfNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "idNumberMatchesTemporaryIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "idValidationCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "identityNumberMatchesBackOfDriversLicence": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "identityNumberMatchesBirthCertificate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "identityNumberMatchesDriversLicence": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "identityNumberMatchesNationalDatabase": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "identityNumberMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "internalBlackListCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "iprsCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isAsylumPaperExpiryDateMatch": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isComparisonNationalIdentityCorrect": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isComparisonPassportCorrect": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isComparisonSelfieCorrect": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isDateOfBirthMatchesBirthCertificate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isNationalIdentityExpiryDateMatch": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isPassportExpiryDateMatch": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isPermitExpiryDateMatch": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isSANational": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isSAPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isSouthAfricanResident": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "isTemporaryIdentityExpiryDateMatch": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "issueDateMatchesBackOfNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "issueDateMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "issueDateMatchesPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastModified": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2022-03-10T12:15:50-04:00"
            ],
            "description": "The date/time when the ratify test was last run"
          },
          "lastNameMatchForeignCertificate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesAsylumPaper": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesBackOfAdditionalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesBackOfDriversLicence": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesBirthCertificate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesDriversLicence": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesNationalDatabase": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesPermit": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesTaxDocument": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "lastNameMatchesTemporaryIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "letshegoCustomKycCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "manualRatify": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "matchCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "nameMatchesBackOfNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "nameMatchesVerifiedBankStatement": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "nationalIdentityIsANationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "nationalIdentityIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "nationalityMatchesPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "ofacCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "parentLastNameMatchesBirthCertificate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "passportCountryMatchesPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "passportIsAPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "passportIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "passportNumberMatchesPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "passportNumberMatchesPermit": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "pepCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "permitIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "personLastNameMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "personNumberMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "phoneNumberMatchesNationalDatabase": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "riskScoreOverride": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "safpsCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "sanctionsListCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "sbsaRelyComplyCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "secureCitizenCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "selfieIsASelfie": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "selfieIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "selfieMatchesAsylumPaper": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "selfieMatchesBackOfAdditionalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "selfieMatchesDriversLicence": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "selfieMatchesNationalDatabase": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "selfieMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "selfieMatchesPassport": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "selfieMatchesTemporaryIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "serialNumberMatchesBackOfNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "serialNumberMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "sexMatchesBackOfNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "sexMatchesNationalIdentity": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "status": {
            "type": "string"
          },
          "taxDocumentIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "taxDocumentMatchesNationalDatabase": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "taxNumberMatchesNationalDatabase": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "taxNumberMatchesTaxDocument": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "taxPayerNameMatchesNationalDatabase": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "temporaryIdentityIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "tracingContext": {
            "type": "string"
          },
          "ukCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "unCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "unscCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "usaWNineIsLegitimate": {
            "$ref": "#/components/schemas/RatifyItemResult"
          },
          "worldCheck": {
            "$ref": "#/components/schemas/RatifyItemResult"
          }
        }
      },
      "RatifyItemResult": {
        "type": "object",
        "description": "A result for an item in a ratify check. If checked =false then other fields wont be populated",
        "properties": {
          "avps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Avp"
            },
            "description": "Weakly typed data included in the result of the check"
          },
          "checked": {
            "type": "boolean",
            "description": "Whether the item was checked"
          },
          "comment": {
            "type": "string",
            "description": "A system generated comment if applicable"
          },
          "inReview": {
            "type": "boolean",
            "description": "Whether the item was in review"
          },
          "lastRun": {
            "type": "string"
          },
          "passed": {
            "type": "boolean",
            "description": "If the item was checked, then whether the check passed or not based on pre defined binary rules. Passed=true implies a favourable outcome. E.g. for a sanctions check passed=true means they are not on a sanctions list"
          },
          "pending": {
            "type": "boolean",
            "description": "Whether the final result of an item is still pending or not"
          },
          "score": {
            "type": "number",
            "description": "Provided as a quantitative score of the result e.g. the % chance a face matches a photo, a credit bureau score etc"
          }
        }
      },
      "RatifyResultType": {
        "description": "Type. NORMAL, BATCH, COMPARISON",
        "type": "string",
        "enum": [
          "BATCH",
          "COMPARISON",
          "NORMAL"
        ]
      }
    },
    "securitySchemes": {
      "JWTBearerAuthorisation": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "description": "A RESTful API using JSON as the data transfer model, covering all tenant-facing functionality in the Eclipse payments platform.",
    "title": "Eclipse ReST API",
    "version": "3.0.0"
  },
  "tags": [
    {
      "name": "d) Customer Management",
      "description": "Operations on an individual customer profile including identity management, addresses, documents, wallets, cards, beneficiaries, and KYC ratification."
    }
  ],
  "paths": {
    "/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/ratify": {
      "get": {
        "summary": "Get the ratify results for the customer",
        "description": "The results are returned from most recent to oldest so pass offset=0 and limit=1 for the most recent one",
        "tags": [
          "d) Customer Management"
        ],
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "customerId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 5
            }
          },
          {
            "name": "offset",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "ratify_type",
            "in": "query",
            "schema": {
              "$ref": "#/components/schemas/RatifyResultType"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EclipseKycResult"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ]
      }
    }
  }
}
```