SPspinwheel
Connect

Verify a User

Changed on

Run an enhanced verification or make corrections to a given identity. On success, the stored profile is replaced with the submitted values. Submit the user's complete profile. Only the first address is verified. The user must already be connected. This endpoint is only accessible via the secure API. This API requires Spinwheel Support approval to enable it before it can be used.

post/v1/users/{userId}/connect/verification

Request

  • Base URL
    https://secure-sandbox-api.spinwheel.io
  • URL
    https://secure-sandbox-api.spinwheel.io/v1/users/{userId}/connect/verification
  • Auth
    • API key in header Authorization
    • or API key in header Authorization

Path parameters

userIdstring required

The userId of the user to verify.

Request body

firstNamestring required

The first name of the user.

lastNamestring required

The last name of the user.

dateOfBirthstring

The date of birth. Formatted as YYYY-MM-DD. Optional: this endpoint always carries the legal name, so an identity can be resolved on phone + name where no date of birth is held.

phoneNumberstring required

The phone number in E.164 format.

ssnstring required

The user's ssn (without hyphens)

Example request

{
  "firstName": "Christy",
  "lastName": "Jenoval",
  "dateOfBirth": "2000-01-01",
  "phoneNumber": "+15555555555",
  "ssn": "999999999",
  "addresses": [
    {
      "addressLine1": "123 Main St",
      "addressLine2": "Unit: 234",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94103"
    }
  ]
}

Response

Success

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "userId": "9226245b-4a4c-48e2-a8cb-9a0e114ed4af",
    "extUserId": "e3119f3a-ac24-4fa8-839b-c9db75848453",
    "connectionId": "e3119f3a-ac24-4fa8-839b-c9db75848453",
    "connectionStatus": "SUCCESS",
    "profile": {
      "addresses": [
        {
          "addressLine1": "123 Main Street",
          "addressLine2": "Unit 208",
          "city": "San Francisco",
          "state": "CA",
          "zip": "90211",
          "zipExtension": "1234"
        }
      ]
    },
    "riskAssessments": [
      {
        "vendor": "PROVE",
        "version": "verify/v2",
        "details": {
          "phoneNumber": "12009041044",
          "lineType": "Mobile",
          "carrier": "AT&T Wireless",
          "countryCode": "US",
          "verified": true,
          "multiVerified": true,
          "cipConfidence": "low",
          "multiCipConfidence": "low",
          "enrollStatus": "enrolled",
          "name": {
            "firstName": 94,
            "lastName": 94,
            "nameScore": 94
          },
          "address": {
            "streetNumber": 100,
            "street": true,
            "city": true,
            "region": true,
            "postalCode": true,
            "addressScore": 100
          },
          "email": {
            "emailAddress": true
          },
          "identifiers": {
            "ssn": true,
            "last4": true,
            "dob": true,
            "driversLicenseNumber": true,
            "driversLicenseState": true
          },
          "reasonCodes": [
            "FN",
            "P5"
          ]
        }
      }
    ]
  }
}

Changes