Endpoints

tip

Postman API documentation is available at https://api.docs.verified.inc.

Use Sandbox for Development and Testing

Please do all development work and testing against our Sandbox environment, which returns mock data. You can use our Production environment when you're ready to go live.

`POST /client/1-click`

Run in Postman

Create a (one time use) session key for the client SDK

Method	`POST`
Path	`/client/1-click`

note

This endpoint is only relevant if your brand's integration type setting is set to SDK in the Dashboard. See Integration Type in the Setup guide for more information about integration types.

Request

POST /client/1-click Request Body
{
    phone?: string
}

Property	Required?	Type	Format	Default	Description	Example
`phone`	Optional	`string`	E.164	none	User's phone number (in E.164 format)	`"+12125550010"`

tip

If you don't have a user's phone number yet, call POST /client/1-click with an empty request body, and the SDK will prompt the user to enter their phone number.

Response

POST /client/1-click Response Body
{
    sessionKey: string
}

Property	Type	Format	Description	Example
`sessionKey`	`string`	Version 4 UUID	Session key that can be used (one time only) to initialize the SDK	`"86227634-bd2e-479d-9541-2c8e7e2e1f6d"`

`GET /1-click`

Run in Postman

Get data for a user who has completed a 1-Click Signup flow

Method	`GET`
Path	`/1-click/{identityUuid}`

Request

Call:

GET /1-click/{identityUuid}

For the {identityUuid} path parameter, use the value of the identityUuid returned by the SDK or included as a URL parameter on the redirect URL.

Response

GET /1-click Response Body
{
    ...1ClickEntity
}

See 1ClickEntity.

`POST /1-click`

Run in Postman

Begin a 1-Click Signup flow

Method	`POST`
Path	`/1-click`

note

This endpoint is only relevant if your brand's integration type setting is set to API in the Dashboard. See Integration Type in the Setup guide for more information about integration types.

Request

POST /1-click Request Body
{
    phone: string,
    email?: string,
    birthDate?: string,
    ssn4?: string,
    fullName?: {
        firstName?: string,
        middleName?: string,
        lastName?: string
    },
    address?: {
        line1?: string,
        line2?: string,
        city?: string,
        state?: string,
        zipCode?: string,
        country?: string
    },
    credentialRequests?: CredentialRequest[]
}

Property	Required?	Type	Format	Default	Description	Example
`phone`	Required	`string`	E.164	none	User's phone number (in E.164 format)	`"+12125550010"`
`email`	Optional	`string`	email	none	User's email address	`"richard@piedpiper.net"`
`birthDate`	Optional	`string`	`YYYY-MM-DD`	none	Birth date	`"1989-08-01"`
`ssn4`	Optional	`string`	4 digits (0-9)	none	Last 4 digits of Social Security Number	`"6789"`
`fullName`	Optional	`Object`	Object with keys for one or more child credentials listed below	none	Full name	`{ "firstName": "Richard", "lastName": "Hendricks" }`
↳ `fullName.firstName`	Optional	`string`	`cAse inSensiTive`	none	First name	`"Richard"`
↳ `fullName.middleName`	Optional	`string`	`cAse inSensiTive`	none	Middle name	`"Harrison"`
↳ `fullName.lastName`	Optional	`string`	`cAse inSensiTive`	none	Last name	`"Hendricks"`
`address`	Optional	`Object`	Object with keys for one or more child credentials listed below	none	Address	`{ "line1": "5320 Newell Rd", "city": "Palo Alto", "state": "CA", "zipCode": "94303", "country": "US" }`
↳ `address.line1`	Optional	`string`	`cAse inSensiTive`	none	Line 1 of address	`"5320 Newell Rd"`
↳ `address.line2`	Optional	`string`	`cAse inSensiTive`	none	Line 2 of address	`""`
↳ `address.city`	Optional	`string`	`cAse inSensiTive`	none	City of address	`"Palo Alto"`
↳ `address.state`	Optional	`string`	2 letter abbreviation (last 2 characters of ISO 3166-2 code for US state/territory) Full state/territory name (ISO 3166-2 subdivision name)	none	State of address	`"CA"` `"California"`
↳ `address.zipCode`	Optional	`string`	ZIP Code (5 digits, 0-9) ZIP+4 (5 digits, 0-9 + `-` + 4 digits, 0-9)	none	ZIP Code of address	`"94303"` `"94303-2846"`
↳ `address.country`	Optional	`string`	2 letter abbreviation (ISO 3166-1 alpha-2 code, currently always `"US"`) Full country name (ISO 3166-1 English short name, currently always `"United States of America"`)	none	Country of address	`"US"` `"United States of America"`
`credentialRequests`	Optional	`CredentialRequest[]`	See `CredentialRequest`	Defined by the default credential requests brand setting in your Dashboard	List of `CredentialRequest` objects (which encode which credentials you're asking for)	See `CredentialRequest` example

Default Credential Requests

If you don't include credentialRequests in the request body, the default credential requests setting for your brand will apply. For reference, the standard credential requests (see here in the Setup guide) include the core KYC data points, all set to optional:

Standard Credential Requests in Code

Standard Credential Requests
[
    {
        "type": "FullNameCredential",
        "children": [
            {
                "type": "FirstNameCredential"
            },
            {
                "type": "MiddleNameCredential"
            },
            {
                "type": "LastNameCredential"
            }
        ]
    },
    {
        "type": "PhoneCredential"
    },
    {
        "type": "AddressCredential",
        "multi": true,
        "children": [
            {
                "type": "Line1Credential"
            },
            {
                "type": "Line2Credential"
            },
            {
                "type": "CityCredential"
            },
            {
                "type": "StateCredential"
            },
            {
                "type": "ZipCodeCredential"
            },
            {
                "type": "CountryCredential"
            }
        ]
    },
    {
        "type": "BirthDateCredential",
    },
    {
        "type": "SsnCredential",
    }
]

Response

POST /1-click Response Body
{
    uuid: string,
    identity: 1ClickEntity
}

Property	Type	Format	Description	Example
`uuid`	`string`	Version 4 UUID	Unique identifier for the `1ClickEntity` that will be returned at the end of the 1-Click Signup flow	`"535dba63-d4bd-442a-b3f6-21b785260a08"`
`identity`	`1ClickEntity`	See `1ClickEntity`	A `1ClickEntity` object, which contains the user's verified data and metadata about it	See `1ClickEntity` example

1-Click Health

`POST /1-click/health`

Run in Postman

Begin a 1-Click Health flow

Method	`POST`
Path	`/1-click/health`

note

This endpoint is only relevant if your brand's integration type setting is set to API in the Dashboard. See Integration Type in the Setup guide for more information about integration types.

Request

POST /1-click/health Request Body
{
    fullName: {
        firstName: string, // required
        middleName?: string,
        lastName: string // required
    },
    birthDate: string, // required
    address?: {
        line1?: string,
        line2?: string,
        city?: string,
        state?: string,
        zipCode?: string,
        country?: string
    },
    sex?: string,
    ssn?: string,
    npi?: string
}

Property	Required?	Type	Format	Default	Description	Example
`fullName`	Required	`Object`	Object with keys for one or more child credentials listed below	none	Full name	`{ "firstName": "Richard", "lastName": "Hendricks" }`
↳ `fullName.firstName`	Required	`string`	`cAse inSensiTive`	none	First name	`"Richard"`
↳ `fullName.middleName`	Optional	`string`	`cAse inSensiTive`	none	Middle name	`"Harrison"`
↳ `fullName.lastName`	Required	`string`	`cAse inSensiTive`	none	Last name	`"Hendricks"`
`birthDate`	Required	`string`	`YYYY-MM-DD`	none	Birth date	`"1989-08-01"`
`address`	Optional	`Object`	Object with keys for one or more child credentials listed below	none	Address	`{ "line1": "5320 Newell Rd", "city": "Palo Alto", "state": "CA", "zipCode": "94303", "country": "US" }`
↳ `address.line1`	Optional	`string`	`cAse inSensiTive`	none	Line 1 of address	`"5320 Newell Rd"`
↳ `address.line2`	Optional	`string`	`cAse inSensiTive`	none	Line 2 of address	`""`
↳ `address.city`	Optional	`string`	`cAse inSensiTive`	none	City of address	`"Palo Alto"`
↳ `address.state`	Optional	`string`	2 letter abbreviation (last 2 characters of ISO 3166-2 code for US state/territory)	none	State of address	`"CA"`
↳ `address.zipCode`	Optional	`string`	ZIP Code (5 digits, 0-9)	none	ZIP Code of address	`"94303"`
↳ `address.country`	Optional	`string`	2 letter abbreviation (ISO 3166-1 alpha-2 code, currently always `"US"`)	none	Country of address	`"US"`
`sex`	Optional	`enum` Possible values: `"Male"` `"Female"` `"Non-Binary"`	`Title Case`	none	Sex	`"Male"`
`ssn`	Optional	`string`	9 digits (0-9)	none	Social Security Number	`"000456789"`
`npi`	Optional	`string`	10 digits (0-9)	Defined by the providers brand setting in your Dashboard	National Provider Identifier	`"0123456789"`

Response

POST /1-click/health Response Body
{
    healthDataUuid: string,
    status: "PENDING" | "PROCESSING" | "SUCCEEDED" | "FAILED" | "PARTIAL"
}

Property	Type	Format	Description	Example
`healthDataUuid`	`string`	Version 4 UUID	Unique identifier for the `1ClickHealthEntity` that will be returned at the end of the 1-Click Health flow	`"9e12fe5b-5bb8-410a-ac6b-6e053e4c7e8d"`
`status`	`enum` Possible values: `"PENDING"` `"PROCESSING"` `"SUCCEEDED"` `"FAILED"` `"PARTIAL"`	`UPPER_SNAKE_CASE`	Status of the 1-Click Health flow	`"PROCESSING"`

`GET /1-click/health`

Run in Postman

Get data for a user who has completed a 1-Click Health flow

Method	`GET`
Path	`/1-click/health/{healthDataUuid}`

Request

Call:

GET /1-click/health/{healthDataUuid}

For the {healthDataUuid} path parameter, use the value of the healthDataUuid returned by the SDK or POST /1-click/health.

Response

GET /1-click/health Response Body
{
    ...1ClickHealthEntity
}

See 1ClickHealthEntity.

Verification

`GET /1-click/verifications`

Check the status of a verification flow

Method	`GET`
Path	`/1-click/verifications/{verificationUuid}`

Request

Call:

GET /1-click/verifications/{verificationUuid}

For the {verificationUuid} path parameter, use the value of the verificationUuid included as a URL parameter on the redirect URL.

Response

GET /1-click/verifications Response Body
{
    ...1ClickVerificationEntity
}

See 1ClickVerificationEntity.

1-Click Signup​

POST /client/1-click​

Request​

Response​

GET /1-click​

Request​

Response​

POST /1-click​

Request​

Default Credential Requests​

Response​

1-Click Health​

POST /1-click/health​

Request​

Response​

GET /1-click/health​

Request​

Response​

Verification​

GET /1-click/verifications​

Request​

Response​

1-Click Signup

`POST /client/1-click`

Request

Response

`GET /1-click`

Request

Response

`POST /1-click`

Request

Default Credential Requests

Response

1-Click Health

`POST /1-click/health`

Request

Response

`GET /1-click/health`

Request

Response

Verification

`GET /1-click/verifications`

Request

Response