Skip to main content
POST
/
v3
/
complete
Complete Flow
package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"individual\": {\n    \"firstName\": \"Tod\",\n    \"lastName\": \"Weedall\",\n    \"addresses\": [\n      {\n        \"address\": \"39 South Trail\",\n        \"city\": \"San Antonio\",\n        \"extendedAddress\": \"Apt 23\",\n        \"postalCode\": \"78285\",\n        \"region\": \"TX\"\n      }\n    ],\n    \"emailAddresses\": [\n      \"jdoe@example.com\"\n    ],\n    \"dob\": \"1981-01\",\n    \"ssn\": \"265228370\"\n  },\n  \"correlationId\": \"713189b8-5555-4b08-83ba-75d08780aebd\"\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))

}
{
  "success": true,
  "next": {
    "done": "done"
  }
}
Use the following base URLs when integrating:https://platform.uat.proveapis.com - North America Sandbox Environmenthttps://platform.proveapis.com - North America Production Environment
When implementing the KYC add-on, you need to pass in first name, last name, DOB, and SSN (or address) to ensure you receive back the KYC and CIP fields.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
correlationId
string
required

The unique ID that Prove generates for the flow. It is returned from the Start endpoint and cannot be reused outside of a single flow.

Example:

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

​
individual
object
required
Example:
{
  "firstName": "Tod",
  "lastName": "Weedall",
  "addresses": [
    {
      "address": "39 South Trail",
      "city": "San Antonio",
      "extendedAddress": "Apt 23",
      "postalCode": "78285",
      "region": "TX"
    }
  ],
  "emailAddresses": ["jdoe@example.com"],
  "dob": "1981-01-17",
  "ssn": "265228370"
}

Response

Successful request.

​
next
object
required

The next set of allowed calls in the same flow.

Example:
{ "done": "done" }
​
success
boolean
required

True if the individual was verified successfully.

Example:

true

​
evaluation
object

The evaluation result for the policy

​
idv
object
Example:
{
  "multiCIPConfidence": "multiCIPConfidence",
  "dataSource2": {
    "cipConfidence": "cipConfidence",
    "reasonCodes": ["reasonCodes", "reasonCodes"],
    "address": {
      "distance": 6.027456183070403,
      "city": true,
      "streetNumber": 1,
      "street": true,
      "postalCode": true,
      "region": true,
      "addressScore": 0
    },
    "identifiers": { "last4": true, "dob": true, "ssn": true },
    "name": {
      "firstName": 5,
      "lastName": 5,
      "nameScore": 2
    },
    "email": { "emailAddress": true }
  },
  "dataSource1": {
    "cipConfidence": "cipConfidence",
    "reasonCodes": ["reasonCodes", "reasonCodes"],
    "address": {
      "distance": 6.027456183070403,
      "city": true,
      "streetNumber": 1,
      "street": true,
      "postalCode": true,
      "region": true,
      "addressScore": 0
    },
    "identifiers": { "last4": true, "dob": true, "ssn": true },
    "name": {
      "firstName": 5,
      "lastName": 5,
      "nameScore": 2
    },
    "email": { "emailAddress": true }
  }
}
​
kyc
object
Example:
{
  "totalHits": 9,
  "amlTypeLists": [
    {
      "listHits": 7,
      "amlType": "amlType",
      "fields": [
        {
          "name": "name",
          "source": "source",
          "value": "value"
        },
        {
          "name": "name",
          "source": "source",
          "value": "value"
        }
      ]
    },
    {
      "listHits": 7,
      "amlType": "amlType",
      "fields": [
        {
          "name": "name",
          "source": "source",
          "value": "value"
        },
        {
          "name": "name",
          "source": "source",
          "value": "value"
        }
      ]
    }
  ]
}
⌘I