createContinuousCheck

{
  "type": "object",
  "description": "Continuous check allows for background checks to be performed on the same people or vehicles periodically and notifies if new information is found. Allowing companies to keep an eye on their workforce or vehicle fleet for any recent wrongdoing they might be involved in.",
  "required": [
    "ContinuousCheckStatus",
    "Frequency",
    "LastCheckID"
  ],
  "properties": {
    "ContinuousCheckID": {
      "type": "string",
      "description": "Continuous check ID [partition key and sort key]"
    },
    "ContinuousCheckStatus": {
      "type": "string",
      "description": "Shows whether the background check score rose, fell, stood the same or was just created",
      "enum": [
        "new",
        "up",
        "down",
        "same"
      ]
    },
    "CreationDate": {
      "type": "string",
      "format": "date",
      "description": "Continuous check creation date in RFC3339 format"
    },
    "Enabled": {
      "type": "boolean",
      "description": "Indicates whether continuous check is enabled"
    },
    "Frequency": {
      "type": "string",
      "description": "Time between background checks. It can be daily, weekly, monthly, yearly or have a custom frequency written as a number accompanied by d: day, w: week, m: month, y: year for instance: 3d: every three days, 2w: every two weeks"
    },
    "History": {
      "type": "object",
      "description": "Represents to changelog entry of a continuous check",
      "properties": {
        "changes": {
          "type": "array",
          "description": "Change list of background check scores",
          "items": {
            "type": "object",
            "description": "Represents changes in check scores between continuous checks",
            "properties": {
              "dataset_score_changes": {
                "type": "number",
                "description": "Old and new score map by dataset"
              },
              "score_changes": {
                "type": "array",
                "description": "Old and new score list",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          }
        },
        "check_id": {
          "type": "string",
          "description": "Check ID"
        },
        "continuous_check_id": {
          "type": "string",
          "description": "Continuous check ID"
        },
        "creation_date": {
          "type": "string",
          "format": "date",
          "description": "Continuous check creation date in RFC3339 format\r\n"
        },
        "previous_check_id": {
          "type": "string",
          "description": "Previous check ID"
        }
      }
    },
    "LastCheckID": {
      "type": "string",
      "description": "Last check ID"
    },
    "NextRunDate": {
      "type": "string",
      "format": "date",
      "description": "Next background check date, in RFC3339 format (without time)"
    },
    "OriginalCheck": {
      "type": "object",
      "description": "Represents a background check",
      "required": [
        "check_id",
        "country",
        "creation_date",
        "id_score",
        "score",
        "status",
        "statuses",
        "summary",
        "type"
      ],
      "properties": {
        "birth_certificate": {
          "type": "string",
          "description": "Person birth certificate"
        },
        "check_id": {
          "type": "string",
          "description": "Background check ID"
        },
        "company_summary": {
          "type": "object",
          "description": "Summary of the company background check process",
          "properties": {
            "names_found": {
              "type": "array",
              "description": "Names found during the background check process",
              "items": {
                "type": "object",
                "description": "Represents names found during the process",
                "required": [
                  "first_name",
                  "last_name",
                  "count"
                ],
                "properties": {
                  "count": {
                    "type": "integer",
                    "description": "Times this name was found during the background check process"
                  },
                  "first_name": {
                    "type": "string",
                    "description": "First name found in the background check"
                  },
                  "last_name": {
                    "type": "string",
                    "description": "Last name found in the background check"
                  }
                }
              }
            }
          }
        },
        "country": {
          "type": "string",
          "description": "ID Document country",
          "enum": [
            "ALL",
            "BR",
            "CL",
            "CO",
            "CR",
            "EC",
            "MX",
            "PE",
            "AR"
          ]
        },
        "creation_date": {
          "type": "string",
          "format": "date-time",
          "description": "Background check creation date"
        },
        "date_of_birth": {
          "type": "string",
          "format": "date-time",
          "description": "Person birthdate. Shown only if provided during check creation. YYYY-MM-DD format"
        },
        "diplomatic_id": {
          "type": "string",
          "description": "Person diplomatic id"
        },
        "driver_license": {
          "type": "string",
          "description": "Person driver's license"
        },
        "first_name": {
          "type": "string",
          "description": "Person or entity first name. Shown only if provided during check creation"
        },
        "foreign_id": {
          "type": "string",
          "description": "Person foreign identification"
        },
        "homonym_probability": {
          "type": "number",
          "format": "float",
          "description": "[Experimental] Analyzes the probability that the results by name are attributed to a homonym. Number between 0 and 1 where 1 is the the greatest probability"
        },
        "homonym_score": {
          "type": "number",
          "format": "float",
          "description": "Background check score including results by name only. This might contain homonym information"
        },
        "homonym_scores": {
          "type": "array",
          "description": "Background check scores by name for each profile group. [Deprecated for API key V1]",
          "items": {
            "type": "object",
            "description": "Represents dataset scores. A score is a number between 0 and 1 that indicates how trustworthy the person, vehicle, or company is accordig to the result of the background check. Severity represents the risk associated with each dataset according to the background check. Keep in mind that you should use either the score or the severity but not both",
            "required": [
              "data_set",
              "severity",
              "score",
              "by_id",
              "by_name"
            ],
            "properties": {
              "by_id": {
                "type": "object",
                "description": "Dataset score detail of the background check result by identity document",
                "required": [
                  "result",
                  "severity",
                  "score"
                ],
                "properties": {
                  "result": {
                    "type": "string",
                    "description": "Overall result of the data collected. If at least one collected data status is found, the result will be found, otherwise, it will be the most frecuent status",
                    "enum": [
                      "pending",
                      "found",
                      "not_found",
                      "error",
                      "delayed",
                      "ignored"
                    ]
                  },
                  "score": {
                    "type": "number",
                    "format": "float",
                    "description": "Dataset score. Number between 0 and 1 where 1 is the best score."
                  },
                  "severity": {
                    "type": "string",
                    "description": "Risk asociated with each category for the search according to the information found. None is returned when the person, vehicle or company is in the clear. Unknown is returned when the score is none",
                    "enum": [
                      "unknown",
                      "none",
                      "very_low",
                      "low",
                      "medium",
                      "high",
                      "very_high"
                    ]
                  }
                }
              },
              "by_name": {
                "type": "object",
                "description": "Score detail of the background check results by name. Might include homonyms",
                "required": [
                  "result",
                  "severity",
                  "score"
                ],
                "properties": {
                  "result": {
                    "type": "string",
                    "description": "Overall result of the data collected. If at least one collected data status is found, the result will be found, otherwise, it will be the most frecuent status",
                    "enum": [
                      "pending",
                      "found",
                      "not_found",
                      "error",
                      "delayed",
                      "ignored"
                    ]
                  },
                  "score": {
                    "type": "number",
                    "format": "float",
                    "description": "Dataset score. Number between 0 and 1 where 1 is the best score."
                  },
                  "severity": {
                    "type": "string",
                    "description": "Risk asociated with each category for the search according to the information found. None is returned when the person, vehicle or company is in the clear. Unknown is returned when the score is none",
                    "enum": [
                      "unknown",
                      "none",
                      "very_low",
                      "low",
                      "medium",
                      "high",
                      "very_high"
                    ]
                  }
                }
              },
              "data_set": {
                "type": "string",
                "description": "Dataset summed up to create the score",
                "enum": [
                  "affiliations_and_insurances",
                  "alert_in_media",
                  "behavior",
                  "business_background",
                  "criminal_record",
                  "driving_licenses",
                  "international_background",
                  "legal_background",
                  "personal_identity",
                  "professional_background",
                  "traffic_fines",
                  "vehicle_information",
                  "vehicle_permits",
                  "taxes_and_finances"
                ]
              },
              "result": {
                "type": "string",
                "description": "Overall result of the data collected. If at least one collected data status is found, the result will be found, otherwise, it will be the most frecuent status",
                "enum": [
                  "pending",
                  "found",
                  "not_found",
                  "error",
                  "delayed",
                  "ignored"
                ]
              },
              "score": {
                "type": "number",
                "format": "float",
                "description": "Dataset score. Number between 0 and 1 where 1 is the best score."
              },
              "severity": {
                "description": "Risk asociated with each category for the search according to the information found. None is returned when the person, vehicle or company is in the clear. Unknown is returned when the score is none due to a problem with one of the searches",
                "enum": [
                  "unknown",
                  "none",
                  "very_low",
                  "low",
                  "medium",
                  "high",
                  "very_high"
                ],
                "type": "object"
              }
            }
          }
        },
        "id_score": {
          "type": "number",
          "format": "float",
          "description": "Background check score regarding results by ID number only. It is a number between 0 and 1 where 1 is the best score. This result is a weighted average of the id_scores listed under scores."
        },
        "issue_date": {
          "type": "string",
          "format": "date-time",
          "description": "Issue date of the person ID"
        },
        "last_name": {
          "type": "string",
          "description": "Person or entity last name. Shown only if provided during check creation"
        },
        "license_plate": {
          "type": "string",
          "description": "Vehicle license plate"
        },
        "national_id": {
          "type": "string",
          "description": "Person national identification"
        },
        "native_country": {
          "type": "string",
          "description": "Person origin country",
          "enum": [
            "ad",
            "ae",
            "af",
            "ag",
            "ai",
            "al",
            "am",
            "an",
            "ao",
            "aq",
            "ar",
            "as",
            "at",
            "au",
            "aw",
            "ax",
            "az",
            "ba",
            "bb",
            "bd",
            "be",
            "bf",
            "bg",
            "bh",
            "bi",
            "bj",
            "bm",
            "bn",
            "bo",
            "br",
            "bs",
            "bt",
            "bv",
            "bw",
            "by",
            "bz",
            "ca",
            "cc",
            "cd",
            "cf",
            "cg",
            "ch",
            "ci",
            "ck",
            "cl",
            "cm",
            "cn",
            "co",
            "cr",
            "cu",
            "cv",
            "cx",
            "cy",
            "cz",
            "de",
            "dj",
            "dk",
            "dm",
            "do",
            "dz",
            "ea",
            "ec",
            "ee",
            "eg",
            "eh",
            "er",
            "es",
            "et",
            "fi",
            "fj",
            "fk",
            "fm",
            "fo",
            "fr",
            "ga",
            "gb",
            "gd",
            "ge",
            "gf",
            "gg",
            "gh",
            "gi",
            "gl",
            "gm",
            "gn",
            "gp",
            "gq",
            "gr",
            "gs",
            "gt",
            "gu",
            "gw",
            "gy",
            "hk",
            "hm",
            "hn",
            "hr",
            "ht",
            "hu",
            "id",
            "ie",
            "il",
            "im",
            "in",
            "io",
            "iq",
            "ir",
            "is",
            "it",
            "je",
            "jm",
            "jo",
            "jp",
            "ke",
            "kg",
            "kh",
            "ki",
            "km",
            "kn",
            "kp",
            "kr",
            "kw",
            "ky",
            "kz",
            "la",
            "lb",
            "lc",
            "li",
            "lk",
            "lr",
            "ls",
            "lt",
            "lu",
            "lv",
            "ly",
            "ma",
            "mc",
            "md",
            "me",
            "mg",
            "mh",
            "mk",
            "ml",
            "mm",
            "mn",
            "mo",
            "mp",
            "mq",
            "mr",
            "ms",
            "mt",
            "mu",
            "mv",
            "mw",
            "mx",
            "my",
            "mz",
            "na",
            "nc",
            "ne",
            "nf",
            "ng",
            "ni",
            "nl",
            "no",
            "np",
            "nr",
            "nu",
            "nz",
            "om",
            "pa",
            "pe",
            "pf",
            "pg",
            "ph",
            "pk",
            "pl",
            "pm",
            "pn",
            "pr",
            "ps",
            "pt",
            "pw",
            "py",
            "qa",
            "re",
            "ro",
            "rs",
            "ru",
            "rw",
            "sa",
            "sb",
            "sc",
            "sd",
            "se",
            "sg",
            "sh",
            "si",
            "sj",
            "sk",
            "sl",
            "sm",
            "sn",
            "so",
            "sr",
            "st",
            "sv",
            "sy",
            "sz",
            "tc",
            "td",
            "tf",
            "tg",
            "th",
            "tj",
            "tk",
            "tl",
            "tm",
            "tn",
            "to",
            "tr",
            "tt",
            "tv",
            "tw",
            "tz",
            "ua",
            "ug",
            "um",
            "us",
            "uy",
            "uz",
            "va",
            "vc",
            "ve",
            "vg",
            "vi",
            "vn",
            "vu",
            "wf",
            "ws",
            "ye",
            "yt",
            "za",
            "zm",
            "zw"
          ]
        },
        "owner_document_id": {
          "type": "string",
          "description": "Vehicle owner identification"
        },
        "owner_document_type": {
          "type": "string",
          "description": "Vehicle owner document type"
        },
        "passport": {
          "type": "string",
          "description": "Person passport"
        },
        "payment_date": {
          "type": "string",
          "description": "Vehicle license payment date"
        },
        "pep": {
          "type": "string",
          "description": "Colombian PEP idenfitication for Venezuelans"
        },
        "phone_number": {
          "type": "string",
          "description": "Person phone number. Required by law in order to notify the person their background is being checked"
        },
        "professional_card": {
          "type": "string",
          "description": "Person professional card number"
        },
        "ptp": {
          "type": "string",
          "description": "Temporary residence permit of the person"
        },
        "region": {
          "type": "string",
          "description": "Region where the background is to be checked. By default, background checks in Brazil are performed in region where the person is from. Applies for some Brazil collectors only. Allowed values are: DF: Distrito Federal, AC: Acre, AL: Alagoas, AP: Amapá, AM: Amazonas, BA: Bahía, CE: Ceará, ES: Espírito Santo, GO: Goiás, MA: Maranhão, MT: Mato Grosso, MS: Mato Grosso do Sul, MG: Minas Gerais, PA: Pará, PB: Paraíba, PR: Paraná, PE: Pernambuco, PI: Piauí, RJ: Río de Janeiro, RN: Río Grande do Norte, RS: Río Grande do Sul, RO: Rondônia, RR: Roraima, SC: Santa Catarina, SP: São Paulo, SE: Sergipe, TO : Tocantins.\r\n",
          "enum": [
            "DF",
            "AC",
            "AL",
            "AP",
            "AM",
            "BA",
            "CE",
            "ES",
            "GO",
            "MA",
            "MT",
            "MS",
            "MG",
            "PA",
            "PB",
            "PR",
            "PE",
            "PI",
            "RJ",
            "RN",
            "RS",
            "RO",
            "RR",
            "SC",
            "SP",
            "SE",
            "TO"
          ]
        },
        "report_id": {
          "type": "string",
          "description": "Report ID the background check is associated with"
        },
        "score": {
          "type": "number",
          "format": "float",
          "description": "Background check score. Number between 0 and 1 where 1 is the best score"
        },
        "scores": {
          "type": "array",
          "description": "Background check score of each profile group and dataset",
          "items": {
            "type": "object",
            "description": "Represents dataset scores. A score is a number between 0 and 1 that indicates how trustworthy the person, vehicle, or company is accordig to the result of the background check. Severity represents the risk associated with each dataset according to the background check. Keep in mind that you should use either the score or the severity but not both",
            "required": [
              "data_set",
              "severity",
              "score",
              "by_id",
              "by_name"
            ],
            "properties": {
              "by_id": {
                "type": "object",
                "description": "Dataset score detail of the background check result by identity document",
                "required": [
                  "result",
                  "severity",
                  "score"
                ],
                "properties": {
                  "result": {
                    "type": "string",
                    "description": "Overall result of the data collected. If at least one collected data status is found, the result will be found, otherwise, it will be the most frecuent status",
                    "enum": [
                      "pending",
                      "found",
                      "not_found",
                      "error",
                      "delayed",
                      "ignored"
                    ]
                  },
                  "score": {
                    "type": "number",
                    "format": "float",
                    "description": "Dataset score. Number between 0 and 1 where 1 is the best score."
                  },
                  "severity": {
                    "type": "string",
                    "description": "Risk asociated with each category for the search according to the information found. None is returned when the person, vehicle or company is in the clear. Unknown is returned when the score is none",
                    "enum": [
                      "unknown",
                      "none",
                      "very_low",
                      "low",
                      "medium",
                      "high",
                      "very_high"
                    ]
                  }
                }
              },
              "by_name": {
                "type": "object",
                "description": "Score detail of the background check results by name. Might include homonyms",
                "required": [
                  "result",
                  "severity",
                  "score"
                ],
                "properties": {
                  "result": {
                    "type": "string",
                    "description": "Overall result of the data collected. If at least one collected data status is found, the result will be found, otherwise, it will be the most frecuent status",
                    "enum": [
                      "pending",
                      "found",
                      "not_found",
                      "error",
                      "delayed",
                      "ignored"
                    ]
                  },
                  "score": {
                    "type": "number",
                    "format": "float",
                    "description": "Dataset score. Number between 0 and 1 where 1 is the best score."
                  },
                  "severity": {
                    "type": "string",
                    "description": "Risk asociated with each category for the search according to the information found. None is returned when the person, vehicle or company is in the clear. Unknown is returned when the score is none",
                    "enum": [
                      "unknown",
                      "none",
                      "very_low",
                      "low",
                      "medium",
                      "high",
                      "very_high"
                    ]
                  }
                }
              },
              "data_set": {
                "type": "string",
                "description": "Dataset summed up to create the score",
                "enum": [
                  "affiliations_and_insurances",
                  "alert_in_media",
                  "behavior",
                  "business_background",
                  "criminal_record",
                  "driving_licenses",
                  "international_background",
                  "legal_background",
                  "personal_identity",
                  "professional_background",
                  "traffic_fines",
                  "vehicle_information",
                  "vehicle_permits",
                  "taxes_and_finances"
                ]
              },
              "result": {
                "type": "string",
                "description": "Overall result of the data collected. If at least one collected data status is found, the result will be found, otherwise, it will be the most frecuent status",
                "enum": [
                  "pending",
                  "found",
                  "not_found",
                  "error",
                  "delayed",
                  "ignored"
                ]
              },
              "score": {
                "type": "number",
                "format": "float",
                "description": "Dataset score. Number between 0 and 1 where 1 is the best score."
              },
              "severity": {
                "description": "Risk asociated with each category for the search according to the information found. None is returned when the person, vehicle or company is in the clear. Unknown is returned when the score is none due to a problem with one of the searches",
                "enum": [
                  "unknown",
                  "none",
                  "very_low",
                  "low",
                  "medium",
                  "high",
                  "very_high"
                ],
                "type": "object"
              }
            }
          }
        },
        "status": {
          "type": "string",
          "description": "Result status of the background check. **Not_started** means the background check is still in queue, since there is a limit of background checks that can be processed simultaneously, **completed** means the check finished successfully, **error** means the check failed, **in_progress** means the check is currently being processed, **delayed** means the check is waiting for an additional requirement to be met, this can last up to 3 days. **Completed** and **error** are the two only final statuses",
          "enum": [
            "not_started",
            "in_progress",
            "completed",
            "error",
            "delayed"
          ]
        },
        "statuses": {
          "type": "array",
          "description": "Database status list",
          "items": {
            "type": "object",
            "description": "Represents the status of databases used to generate background checks",
            "properties": {
              "data_set": {
                "type": "string",
                "description": "Background check dataset",
                "enum": [
                  "affiliations_and_insurances",
                  "alert_in_media",
                  "behavior",
                  "business_background",
                  "criminal_record",
                  "driving_licenses",
                  "international_background",
                  "legal_background",
                  "personal_identity",
                  "professional_background",
                  "traffic_fines",
                  "vehicle_information",
                  "vehicle_permits",
                  "taxes_and_finances"
                ]
              },
              "database_id": {
                "type": "string",
                "description": "Database ID. Can be used to verify the database status"
              },
              "database_name": {
                "type": "string",
                "description": "Background check database name. Do not use this field to identify the database as it may change during the check execution. Use database_id instead"
              },
              "invalid_inputs": {
                "type": "array",
                "description": "List of missing or invalid inputs",
                "items": {
                  "type": "string"
                }
              },
              "status": {
                "description": "Result status of the background check. **Not_started** means the background check is still in queue, since there is a limit of background checks that can be processed simultaneously, **completed** means the search finished successfully, **error** means the search failed, **expired** means the search took too long to finish and therefore failed, **skipped** means the search failed because a wrong number or type of parameters was provided, **delayed** means the search is waiting for an additional requirement to be met and can last up to 3 days",
                "enum": [
                  "not_started",
                  "completed",
                  "expired",
                  "error",
                  "delayed",
                  "skipped"
                ],
                "type": "object"
              }
            }
          }
        },
        "summary": {
          "type": "object",
          "description": "Background check process summary",
          "required": [
            "names_found"
          ],
          "properties": {
            "date_of_birth": {
              "type": "string",
              "format": "date-time",
              "description": "Person date of birth in RFC3339 format"
            },
            "death_date": {
              "type": "string",
              "format": "date-time",
              "description": "Person date of death"
            },
            "drivers_license": {
              "type": "string",
              "description": "Person driver's license"
            },
            "gender": {
              "type": "string",
              "description": "Person gender",
              "enum": [
                "male",
                "female"
              ]
            },
            "identity_status": {
              "type": "string",
              "description": "Indicates whether a person was found, found as dead or not found at all",
              "enum": [
                "found",
                "not_found",
                "dead"
              ]
            },
            "names_found": {
              "type": "array",
              "description": "Names found during the background check process",
              "items": {
                "type": "object",
                "description": "Represents names found during the process",
                "required": [
                  "first_name",
                  "last_name",
                  "count"
                ],
                "properties": {
                  "count": {
                    "type": "integer",
                    "description": "Times this name was found during the background check process"
                  },
                  "first_name": {
                    "type": "string",
                    "description": "First name found in the background check"
                  },
                  "last_name": {
                    "type": "string",
                    "description": "Last name found in the background check"
                  }
                }
              }
            },
            "nss": {
              "type": "string",
              "description": "Social security number of the person (Mexico)"
            },
            "rfc": {
              "type": "string",
              "description": "Federal taxpayer registration number of the person"
            }
          }
        },
        "tax_id": {
          "type": "string",
          "description": "Person or company tax id"
        },
        "type": {
          "description": "Background check type",
          "enum": [
            "company",
            "person",
            "vehicle"
          ],
          "type": "object"
        },
        "update_date": {
          "type": "string",
          "format": "date-time",
          "description": "Background check update date"
        },
        "vehicle_id": {
          "type": "string",
          "description": "Vehicle identification"
        },
        "vehicle_summary": {
          "type": "object",
          "description": "Summary of the vehicle background check process",
          "properties": {
            "capacity": {
              "type": "integer",
              "description": "Number of passengers allowed to travel in the vehicle"
            },
            "color": {
              "type": "string",
              "description": "Vehicle color"
            },
            "license_plate": {
              "type": "string",
              "description": "Vehicle license plate"
            },
            "manufacturer": {
              "type": "string",
              "description": "Vehicle manufacturer"
            },
            "model": {
              "type": "string",
              "description": "Vehicle model"
            },
            "number_of_doors": {
              "type": "integer",
              "description": "Vehicle door count"
            },
            "obligatory_insurance_expiration_date": {
              "type": "string",
              "format": "date",
              "description": "Expiration date of the vehicle compulsory insurance "
            },
            "obligatory_insurance_status": {
              "type": "string",
              "description": "Status of the vehicle compulsory insurances"
            },
            "service_type": {
              "type": "string",
              "description": "Vehicle service type"
            },
            "vehicle_category": {
              "type": "string",
              "description": "Vehicle category"
            },
            "vehicle_id": {
              "type": "string",
              "description": "Vehicle ID"
            },
            "vehicle_type": {
              "type": "string",
              "description": "Vehicle type"
            },
            "year": {
              "type": "integer",
              "description": "Vehicle model year"
            }
          }
        },
        "wrong_inputs": {
          "type": "array",
          "description": "List of parameters entered during background check creation that do not match the information obtained",
          "items": {
            "type": "object",
            "description": "Represents a parameter entered during the background check creation that does not match the information obtained",
            "properties": {
              "Input": {
                "type": "string",
                "description": "Parameter entered that differs from the information obtained",
                "enum": [
                  "document_expedition_date"
                ]
              }
            }
          }
        }
      }
    },
    "UpdateDate": {
      "type": "string",
      "format": "date",
      "description": "Continuous check update date in RFC3339 format"
    }
  }
}