Veriph.One's API (1.X.X)

This object determines whether the verification process will capture an unknown number or do a 2FA/MFA flow with a known one. In case of the latter, the verification will be rejected if the user verifies a different number.

Necessary data to detect bots, unique transactions, fraudsters, and user's approximate location.

Expected number's country code, without '+' sign or non-numeric characters

Expected phone number without country code or non-numeric characters

The channel to use for the message. Values: SMS [0], WhatsApp [1], Phone Call [2].

The OTP to include in the message template. Enforced string length range: 4-16. Only alphanumeric characters accepted (no diacritics, whitespace or symbols): 0-9, a-z, and A-Z.

A string ignored for WhatsApp but used for other channels with the purpose of letting the user know who is sending the OTP. Use a short brand/product name, at least 2 characters long. The string might be shortened if space is needed to fit the message inside a single SMS message. The string is shown inside parentheses for SMS; for example, in english: ({brandLabel}) Your verification code is ${otpCode}. Do not share it with others. For phone calls, the structure is as follows: Your verification code for ${brandLabel} is ${otpCode}. Do not share it with others..

String determining the language of the message to be sent in ISO 639-1 format. Currently, only en and es are supported.

Used to detect fraudsters, bots, and identity theft; please ensure that you are sending proper values as obtained by your server.

An optional UUID used to identify a group of identity validation requests as a unique transaction. Used for billing and data-coherence analysis of a single end-user identity. If one isn't provided, a new one will be provided as part of the response if the request was successful and useTransaction is set to true.

A boolean value that governs whether the request will create a request-bundling transaction if transactionUuid wasn't provided (ignored otherwise). The default is false. It is recommended to use transactions if you will query multiple web services to validate or obtain insights for a single user's identity; by doing so, you can leverage lower pricing (if your plan allows it) and obtain additional data points and better scoring (as we integrate more sources in our data-coherence analysis).

An optional string containing a UUID provided by your application to leverage idempotency and retrieve the results of the request in case of an interrupted connection.

The desired data bundles to return in the form of a string array, please consider that this is directly linked to pricing and omitting a package will return some fields as null. Morever, including a package might increase the cost of your request and make it slower (as more data is queried and generated). Contact your sales representative for more details.

The phone number to enrich; can be provided as a string in E.164 format (e.g., +14155552671) or an object containing country code and number separately. Can only be null if ipAddress is provided.

An optional UUID used to identify a group of identity validation requests as a unique transaction. Used for billing and data-coherence analysis of a single end-user identity. If one isn't provided, a new one will be provided as part of the response if the request was successful and useTransaction is set to true.

A boolean value that governs whether the request will create a request-bundling transaction if transactionUuid wasn't provided (ignored otherwise). The default is false. It is recommended to use transactions if you will query multiple web services to validate or obtain insights for a single user's identity; by doing so, you can leverage lower pricing (if your plan allows it) and obtain additional data points and better scoring (as we integrate more sources in our data-coherence analysis).

An optional string containing a UUID provided by your application to leverage idempotency and retrieve the results of the request in case of an interrupted connection.

The phone number to use for the search. It can be provided as a string in E.164 format (e.g., +14155552671) or an object containing the country code and number separately. Can only be null if an email is provided.

The email address to use for the search. Must be a valid email address; if the email is invalid, the service will treat it as null. Can only be null if phoneNumber is provided.

An optional UUID used to identify a group of identity validation requests as a unique transaction. Used for billing and data-coherence analysis of a single end-user identity. If one isn't provided, a new one will be provided as part of the response if the request was successful and useTransaction is set to true.

A boolean value that governs whether the request will create a request-bundling transaction if transactionUuid wasn't provided (ignored otherwise). The default is false. It is recommended to use transactions if you will query multiple web services to validate or obtain insights for a single user's identity; by doing so, you can leverage lower pricing (if your plan allows it) and obtain additional data points and better scoring (as we integrate more sources in our data-coherence analysis).

An optional string containing a UUID provided by your application to leverage idempotency and retrieve the results of the request in case of an interrupted connection.

The desired data bundles to return in the form of a string array, please consider that this is directly linked to pricing and omitting a package will return some fields as null. Morever, including a package might increase the cost of your request and make it slower (as more data is queried and generated). Contact your sales representative for more details.

An optional UUID used to identify a group of identity validation requests as a unique transaction. Used for billing and data-coherence analysis of a single end-user identity. If one isn't provided, a new one will be provided as part of the response if the request was successful and useTransaction is set to true.

A boolean value that governs whether the request will create a request-bundling transaction if transactionUuid wasn't provided (ignored otherwise). The default is false. It is recommended to use transactions if you will query multiple web services to validate or obtain insights for a single user's identity; by doing so, you can leverage lower pricing (if your plan allows it) and obtain additional data points and better scoring (as we integrate more sources in our data-coherence analysis).

An optional string containing a UUID provided by your application to leverage idempotency and retrieve the results of the request in case of an interrupted connection.

Options and potential configurations for your request that determine sensitivity levels and the type of analysis you want to perform. Sending this value as null will set all of the underlying properties to their defaults.

An optional UUID used to identify a group of identity validation requests as a unique transaction. Used for billing and data-coherence analysis of a single end-user identity. If one isn't provided, a new one will be provided as part of the response if the request was successful and useTransaction is set to true.

A boolean value that governs whether the request will create a request-bundling transaction if transactionUuid wasn't provided (ignored otherwise). The default is false. It is recommended to use transactions if you will query multiple web services to validate or obtain insights for a single user's identity; by doing so, you can leverage lower pricing (if your plan allows it) and obtain additional data points and better scoring (as we integrate more sources in our data-coherence analysis).

An optional string containing a UUID provided by your application to leverage idempotency and retrieve the results of the request in case of an interrupted connection.

The IP address to obtain insights from; must be in IPv4 or IPv6 format. Please note that invalid, reserved, private, or local IP addresses (e.g., 127.0.0.1) will return no information.

The user agent string associated with the IP address, which we strongly recommend you provide if possible. If sent, we will run additional checks to detect bots and suspicious/invalid browsers. The value is also used to generate the fraud score and can improve scoring accuracy by over 20%.

The user's language header associated with the IP address; if provided, the value will improve the resulting fraud score. Example of expected value: en-US.

If set to true, the process will ignore the user agent string and treat the IP address as a connection from a mobile app, rather than a browser. Use this field carefully, as it can cause unexpected results if the IP address is not coming from a mobile device. Default value is false.

An optional UUID used to identify a group of identity validation requests as a unique transaction. Used for billing and data-coherence analysis of a single end-user identity. If one isn't provided, a new one will be provided as part of the response if the request was successful and useTransaction is set to true.

A boolean value that governs whether the request will create a request-bundling transaction if transactionUuid wasn't provided (ignored otherwise). The default is false. It is recommended to use transactions if you will query multiple web services to validate or obtain insights for a single user's identity; by doing so, you can leverage lower pricing (if your plan allows it) and obtain additional data points and better scoring (as we integrate more sources in our data-coherence analysis).

An optional string containing a UUID provided by your application to leverage idempotency and retrieve the results of the request in case of an interrupted connection.

Latitude coordinate between -90 and 90

Longitude coordinate between -180 and 180

Accuracy radius in meters (max 50000). If not provided, defaults to 0. Note: High-precision security signals (e.g., isInsidePrison) are only computed when accuracy <= 500 meters; otherwise those fields will be null to avoid false positives.

Custom radius in meters for the financial infrastructure search (defaults to 3000 when omitted).

An optional UUID used to identify a group of identity validation requests as a unique transaction. Used for billing and data-coherence analysis of a single end-user identity. If one isn't provided, a new one will be provided as part of the response if the request was successful and useTransaction is set to true.

A boolean value that governs whether the request will create a request-bundling transaction if transactionUuid wasn't provided (ignored otherwise). The default is false. It is recommended to use transactions if you will query multiple web services to validate or obtain insights for a single user's identity; by doing so, you can leverage lower pricing (if your plan allows it) and obtain additional data points and better scoring (as we integrate more sources in our data-coherence analysis).

An optional string containing a UUID provided by your application to leverage idempotency and retrieve the results of the request in case of an interrupted connection.

A PDF document or JPG image of the Proof of Address to validate encoded as a Base64 string. For better performance and reduced response time, use JPG images and keep the file size as small as possible without compromising readability (please keep in mind that that if the image is too small or pixelated, the OCR will fail and the service can have unintended results). Usually a reasonable file size is within 1 to 3 MBs.