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.

1-Click Signup

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	User's birth date (in Sandbox, this must be "1989-08-01" to pass validation)	"1989-08-01"
ssn4	optional	string	4 digits (0-9)	none	Last 4 digits of user's Social Security Number (in Sandbox, this must be "6789" to pass validation)	"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	Line 1 of address	"5320 Newell Rd"
↳ address.line2	optional	string	cAse inSensiTive	Line 2 of address	""
↳ address.city	optional	string	cAse inSensiTive	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")	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

Sandbox Validation

In Sandbox, you need to do the following to pass validation:

• If you use birthDate, use a value of "1989-08-01".
• If you use ssn4, use a value of "6789".

If you use other values, you'll get the OCE012 error code, which indicates that there's a mismatch.

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

---

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.