Skip to main content
POST
/
v3
/
complete
C#
using Prove.Proveapi;
using Prove.Proveapi.Models.Components;
using System.Collections.Generic;

var sdk = new ProveAPI(auth: "<YOUR_AUTH_HERE>");

V3CompleteRequest req = new V3CompleteRequest() {
    CorrelationId = "713189b8-5555-4b08-83ba-75d08780aebd",
    Individual = new V3CompleteIndividualRequest() {
        Addresses = new List<V3CompleteAddressEntryRequest>() {
            new V3CompleteAddressEntryRequest() {
                Address = "39 South Trail",
                City = "San Antonio",
                ExtendedAddress = "Apt 23",
                PostalCode = "78285",
                Region = "TX",
            },
        },
        Dob = "1981-01",
        EmailAddresses = new List<string>() {
            "jdoe@example.com",
        },
        FirstName = "Tod",
        LastName = "Weedall",
        Ssn = "265228370",
    },
};

var res = await sdk.V3.V3CompleteRequestAsync(req);

// handle response
{
  "success": true,
  "next": {
    "done": "done"
  }
}
When implementing the Know Your Customer (KYC) add-on, pass in first name, last name, DOB, and SSN (or address) to receive the KYC and Customer Identification Program (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
Individual represents a person. · 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"
        }
      ]
    }
  ]
}