Skip to main content
POST
/
v3
/
verify
Initiate Verified Users Session
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.uat.proveapis.com/v3/verify"

	payload := strings.NewReader("{\n  \"firstName\": \"Sheilakathryn\",\n  \"lastName\": \"Butrimovich\",\n  \"emailAddress\": \"sbutrimovichb@who.int\",\n  \"phoneNumber\": \"2001004011\",\n  \"clientHumanId\": \"aad25769-23bb-458c-80db-50296a82c91b\",\n  \"clientRequestId\": \"71010d88-d0e7-4a24-9297-d1be6fefde81\",\n  \"ipAddress\": \"192.168.1.1\",\n  \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:124.0) Gecko/20100101 Firefox/124.0\",\n  \"verificationType\": \"verificationType\",\n  \"clientCustomerId\": \"e0f78bc2-f748-4eda-9d29-d756844507fc\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
{
  "additionalIdentities": [
    {
      "firstName": "Sheilakathryn",
      "lastName": "Butrimovich",
      "reasons": "[AL-1a] (Poor quality identity)",
      "assuranceLevel": "AL-1"
    },
    {
      "firstName": "Sheilakathryn",
      "lastName": "Butrimovich",
      "reasons": "[AL-1a] (Poor quality identity)",
      "assuranceLevel": "AL-1"
    }
  ],
  "evaluation": {
    "key": "{}"
  },
  "phoneNumber": "2001004011",
  "clientRequestId": "71010d88-d0e7-4a24-9297-d1be6fefde81",
  "identity": {
    "firstName": "Sheilakathryn",
    "lastName": "Butrimovich",
    "provePhoneAlias": "4c01021a-7d72-4286-a8f8-d32d5b0cc342",
    "proveId": "a07b94ce-218c-461f-beda-d92480e40f61",
    "reasons": "[AL-1a] (Poor quality identity)",
    "clientHumanId": "7bfbb91d-9df8-4ec0-99a6-de05ecc23a9e",
    "assuranceLevel": "AL-1",
    "clientCustomerId": "261ffa66-961a-4f90-8d93-6c85a450633d"
  },
  "success": "pending",
  "correlationId": "713189b8-5555-4b08-83ba-75d08780aebd"
}
Use the following base URLs when integrating :https://platform.uat.proveapis.com - North America Sandbox Environmenthttps://platform.proveapis.com - North America Production Environmenthttps://platform.uat.eu.proveapis.com - European Union Sandbox Environmenthttps://platform.eu.proveapis.com - European Union Production Environment

Authorizations

​
Authorization
string
header
required

The access token received from the /token endpoint. Refer to the Authentication page for more details.

Body

application/json
​
phoneNumber
string
required

The mobile phone number. US phone numbers can be passed in with or without a leading +1. International phone numbers require a leading +1. Use the appropriate endpoint URL based on the region the number originates from. Acceptable characters are: alphanumeric with symbols '+'.

Example:

"2001004011"

​
verificationType
string
required

The verification method based on the use case and authorization level.

​
clientCustomerId
string

A client-generated unique ID for a specific customer. This can be used by clients to link calls related to the same customer, across different requests or sessions. The format of this ID is defined by the client - Prove recommends using a GUID, but any format can be accepted. Prove does not offer any functionality around the Client Customer ID. Do not include personally identifiable information (PII) in this field.

Example:

"e0f78bc2-f748-4eda-9d29-d756844507fc"

​
clientHumanId
string

An optional client-generated unique ID our Enterprise customer inputs for that consumer across business lines. If the Enterprise customer has been able to identify a consumer across business lines and has a unique identifier for the consumer, they would input this value to Prove.The format of this ID is defined by the client - Prove recommends using a GUID, but any format can be accepted. Do not include personally identifiable information (PII) in this field.

Example:

"aad25769-23bb-458c-80db-50296a82c91b"

​
clientRequestId
string

A client-generated unique ID for a specific session. This can be used to identify specific requests. The format of this ID is defined by the client - Prove recommends using a GUID, but any format can be accepted. Do not include Personally Identifiable Information (PII) in this field.

Example:

"71010d88-d0e7-4a24-9297-d1be6fefde81"

​
emailAddress
string

The email address of the customer. Acceptable characters are: alphanumeric with symbols '@.+'.

Example:

"sbutrimovichb@who.int"

​
firstName
string

The first name of the individual. (required IF verificationType=VerifiedUser)

Example:

"Sheilakathryn"

​
ipAddress
string

The IP address of the customer.

Example:

"192.168.1.1"

​
lastName
string

The last name of the individual. (required IF verificationType=VerifiedUser)

Example:

"Butrimovich"

​
userAgent
string

The User agent of the customer.

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:124.0) Gecko/20100101 Firefox/124.0"

Response

Successful request.

​
correlationId
string
required

The unique ID that Prove generates for the flow. To continue the flow, the field will also be used for each of the subsequent API calls in the same flow - it cannot be reused outside of a single flow.

Example:

"713189b8-5555-4b08-83ba-75d08780aebd"

​
identity
object
required
Example:
{
  "firstName": "Sheilakathryn",
  "lastName": "Butrimovich",
  "provePhoneAlias": "4c01021a-7d72-4286-a8f8-d32d5b0cc342",
  "proveId": "a07b94ce-218c-461f-beda-d92480e40f61",
  "reasons": "[AL-1a] (Poor quality identity)",
  "clientHumanId": "7bfbb91d-9df8-4ec0-99a6-de05ecc23a9e",
  "assuranceLevel": "AL-1",
  "clientCustomerId": "261ffa66-961a-4f90-8d93-6c85a450633d"
}
​
phoneNumber
string
required

The mobile phone number. US phone numbers can be passed in with or without a leading +1. International phone numbers require a leading +1. Use the appropriate endpoint URL based on the region the number originates from. Acceptable characters are: alphanumeric with symbols '+'.

Example:

"2001004011"

​
success
string
required

The result of verification

Example:

"pending"

​
additionalIdentities
object[]

(required IF verificationType=VerifiedUser)

​
clientRequestId
string

A client-generated unique ID for a specific session. This can be used to identify specific requests. The format of this ID is defined by the client - Prove recommends using a GUID, but any format can be accepted. Do not include Personally Identifiable Information (PII) in this field.

Example:

"71010d88-d0e7-4a24-9297-d1be6fefde81"

​
evaluation
object

The evaluation result for the policy. This is an upcoming field but is not yet enabled.

⌘I