Verified 1-Click Signup API v2.0

For full documentation, see https://docs.verified.inc/v2.0.

AUTHORIZATIONAPI Key

Key

Authorization

Value

1-Click

AUTHORIZATIONAPI Key

This folder is using API Key from collectionVerified 1-Click Signup API v2.0

{id}

AUTHORIZATIONAPI Key

This folder is using API Key from collectionVerified 1-Click Signup API v2.0

GETRetrieve a 1-Click Entity

https://core-api.sandbox-verifiedinc.com/v2/1-click/:id?code=<string>

GET /1-click

Retrieves a single 1-click resource with the specified `id`.

Request

Method: GET

URL: https://core-api.sandbox-verifiedinc.com/v2/1-click/:id

Query Parameter:
- code (string): The code for the resource

Response

1ClickEntity

AUTHORIZATIONAPI Key

Key

Authorization

Value

HEADERS

application/json

PARAMS

code

PATH VARIABLES

(Required)

Example Request

curl

curl --location 'https://core-api.sandbox-verifiedinc.com/v2/1-click/94365d9f-721d-4400-9e71-9ae97b5e02b0?code=111111' \
--header 'Authorization: <API Key>' \
--header 'Accept: application/json'

200 OK

Example Response

json

{
  "uuid": "94365d9f-721d-4400-9e71-9ae97b5e02b0",
  "identity": {
    "identifiers": {
      "phone": "+10123456789"
    },
    "credentials": {
      "ssn": "111223333",
      "phone": "+10123456789",
      "birthDate": "631195200000",
      "fullName": {
        "firstName": "Richard",
        "middleName": "Fitzgerald",
        "lastName": "Hendricks"
      },
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 1",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zipCode": "12345"
      }
    },
    "metadata": {
      "identifiers": {
        "userUuid": "562fef5e-cf43-4996-b638-358547e11acb",
        "uuid": {
          "phone": "f2cee20c-f3d6-4c48-a98e-c927470843af"
        },
        "verificationMethod": {
          "phone": null,
          "email": null
        }
      },
      "credentials": {
        "id": {
          "ssn": "f5bcf52e-7a33-416b-9d6a-85b64f36d6b4",
          "phone": "9f626e30-6872-4763-a0c8-09ee7ce160a0",
          "birthDate": "d1bc8a25-67cf-436a-97ce-445a65aa248e",
          "fullName": {
            "firstName": "38cbc045-d641-4a56-a414-3c607c40619b",
            "middleName": "693217bf-3ec5-4265-90a9-cb46dc51ee63",
            "lastName": "691cbcd3-57e5-497a-82d8-678df361724a"
          },
          "address": {
            "line1": "9b274467-c74f-4475-91b3-02592bce9052",
            "line2": "3165eb74-8d9a-47d8-8991-ee7df18734de",
            "city": "84e5e91c-c2c7-4abd-8ed9-251ed4f9c6b1",
            "state": "29d8e9b7-dc4a-409c-8be3-e715ebeece84",
            "country": "660b6ac3-6fa3-4054-8a50-796328e07990",
            "zipCode": "a0a5e1be-3001-4814-84e2-fd3147b70200"
          }
        },
        "verificationMethod": {
          "ssn": null,
          "phone": null,
          "birthDate": null,
          "fullName": {
            "firstName": null,
            "middleName": null,
            "lastName": null
          },
          "address": {
            "line1": null,
            "line2": null,
            "city": null,
            "state": null,
            "country": null,
            "zipCode": null
          }
        },
        "status": {
          "ssn": "valid",
          "phone": "valid",
          "birthDate": "valid",
          "fullName": {
            "firstName": "valid",
            "middleName": "valid",
            "lastName": "valid"
          },
          "address": {
            "line1": "valid",
            "line2": "valid",
            "city": "valid",
            "state": "valid",
            "country": "valid",
            "zipCode": "valid"
          }
        },
        "expirationDate": {
          "ssn": null,
          "phone": null,
          "birthDate": null,
          "fullName": {
            "firstName": null,
            "middleName": null,
            "lastName": null
          },
          "address": {
            "line1": null,
            "line2": null,
            "city": null,
            "state": null,
            "country": null,
            "zipCode": null
          }
        }
      }
    }
  }
}

Content-Type

application/json

PATCHPatch a 1-Click Entity

https://core-api.sandbox-verifiedinc.com/v2/1-click/:id

PATCH /1-click

Patches the 1-click resource by id.

AUTHORIZATIONAPI Key

Key

Authorization

Value

HEADERS

Content-Type

application/json

PATH VARIABLES

(Required) ID of OneClick to update

Bodyraw (json)

json

{
  "birthDate": "<string>"
}

Example Request

curl

curl --location --request PATCH 'https://core-api.sandbox-verifiedinc.com/v2/1-click/94365d9f-721d-4400-9e71-9ae97b5e02b0' \
--header 'Authorization: <API Key>' \
--header 'Accept: application/json' \
--data '{
  "birthDate": "1989-08-01"
}'

200 OK

Example Response

json

{
  "uuid": "94365d9f-721d-4400-9e71-9ae97b5e02b0",
  "identity": {
    "identifiers": {
      "phone": "+10123456789"
    },
    "credentials": {
      "ssn": "111223333",
      "phone": "+10123456789",
      "birthDate": "631195200000",
      "fullName": {
        "firstName": "Richard",
        "middleName": "Fitzgerald",
        "lastName": "Hendricks"
      },
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 1",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zipCode": "12345"
      }
    },
    "metadata": {
      "identifiers": {
        "userUuid": "562fef5e-cf43-4996-b638-358547e11acb",
        "uuid": {
          "phone": "f2cee20c-f3d6-4c48-a98e-c927470843af"
        },
        "verificationMethod": {
          "phone": null,
          "email": null
        }
      },
      "credentials": {
        "id": {
          "ssn": "f5bcf52e-7a33-416b-9d6a-85b64f36d6b4",
          "phone": "9f626e30-6872-4763-a0c8-09ee7ce160a0",
          "birthDate": "d1bc8a25-67cf-436a-97ce-445a65aa248e",
          "fullName": {
            "firstName": "38cbc045-d641-4a56-a414-3c607c40619b",
            "middleName": "693217bf-3ec5-4265-90a9-cb46dc51ee63",
            "lastName": "691cbcd3-57e5-497a-82d8-678df361724a"
          },
          "address": {
            "line1": "9b274467-c74f-4475-91b3-02592bce9052",
            "line2": "3165eb74-8d9a-47d8-8991-ee7df18734de",
            "city": "84e5e91c-c2c7-4abd-8ed9-251ed4f9c6b1",
            "state": "29d8e9b7-dc4a-409c-8be3-e715ebeece84",
            "country": "660b6ac3-6fa3-4054-8a50-796328e07990",
            "zipCode": "a0a5e1be-3001-4814-84e2-fd3147b70200"
          }
        },
        "verificationMethod": {
          "ssn": null,
          "phone": null,
          "birthDate": null,
          "fullName": {
            "firstName": null,
            "middleName": null,
            "lastName": null
          },
          "address": {
            "line1": null,
            "line2": null,
            "city": null,
            "state": null,
            "country": null,
            "zipCode": null
          }
        },
        "status": {
          "ssn": "valid",
          "phone": "valid",
          "birthDate": "valid",
          "fullName": {
            "firstName": "valid",
            "middleName": "valid",
            "lastName": "valid"
          },
          "address": {
            "line1": "valid",
            "line2": "valid",
            "city": "valid",
            "state": "valid",
            "country": "valid",
            "zipCode": "valid"
          }
        },
        "expirationDate": {
          "ssn": null,
          "phone": null,
          "birthDate": null,
          "fullName": {
            "firstName": null,
            "middleName": null,
            "lastName": null
          },
          "address": {
            "line1": null,
            "line2": null,
            "city": null,
            "state": null,
            "country": null,
            "zipCode": null
          }
        }
      }
    }
  }
}

Content-Type

application/json

POSTInitiate and create a 1-Click flow

https://core-api.sandbox-verifiedinc.com/v2/1-click

POST /1-click

Creates a new 1-Click flow. Only the phone number is required. The credential requests and most other optional request attributes use the settings from the Dashboard.

Request

phone (string): The phone number of the user.

email (string) [optional]: The email address of the user.

birthDate (string) [optional]: The birth date of the user.

ssn4 (string) [optional]: The SSN4 date of the user.

credentialRequests (array of CredentialRequests) [optional]: An array of credential requests.

content (object) [optional]:
- title (string): The title of the content.
- description (string): The description of the content.

redirectUrl (uri) [optional]: The URL to redirect after the request is processed.

Response

The response depends on your brand's integration type setting.

AUTHORIZATIONAPI Key

Key

Authorization

Value

HEADERS

Content-Type

application/json

Bodyraw (json)

json

{
  "phone": "<phone>",
  "email": "<email>",
  "credentialRequests": [
    "<string>",
    "<string>"
  ],
  "birthDate": "<string>",
  "content": {
    "title": "<string>",
    "description": "<string>"
  },
  "redirectUrl": "<uri>"
}

Example Request

curl

curl --location 'https://core-api.sandbox-verifiedinc.com/v2/1-click' \
--header 'Authorization: <API Key>' \
--header 'Accept: application/json' \
--data '{
  "phone": "+10123456789"
}'

201 Created

Example Response

json

{
  "uuid": "94365d9f-721d-4400-9e71-9ae97b5e02b0",
  "identity": {
    "identifiers": {
      "phone": "+10123456789"
    },
    "credentials": {
      "ssn": "111223333",
      "phone": "+10123456789",
      "birthDate": "631195200000",
      "fullName": {
        "firstName": "Richard",
        "middleName": "Fitzgerald",
        "lastName": "Hendricks"
      },
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 1",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zipCode": "12345"
      }
    },
    "metadata": {
      "identifiers": {
        "userUuid": "562fef5e-cf43-4996-b638-358547e11acb",
        "uuid": {
          "phone": "f2cee20c-f3d6-4c48-a98e-c927470843af"
        },
        "verificationMethod": {
          "phone": null,
          "email": null
        }
      },
      "credentials": {
        "id": {
          "ssn": "f5bcf52e-7a33-416b-9d6a-85b64f36d6b4",
          "phone": "9f626e30-6872-4763-a0c8-09ee7ce160a0",
          "birthDate": "d1bc8a25-67cf-436a-97ce-445a65aa248e",
          "fullName": {
            "firstName": "38cbc045-d641-4a56-a414-3c607c40619b",
            "middleName": "693217bf-3ec5-4265-90a9-cb46dc51ee63",
            "lastName": "691cbcd3-57e5-497a-82d8-678df361724a"
          },
          "address": {
            "line1": "9b274467-c74f-4475-91b3-02592bce9052",
            "line2": "3165eb74-8d9a-47d8-8991-ee7df18734de",
            "city": "84e5e91c-c2c7-4abd-8ed9-251ed4f9c6b1",
            "state": "29d8e9b7-dc4a-409c-8be3-e715ebeece84",
            "country": "660b6ac3-6fa3-4054-8a50-796328e07990",
            "zipCode": "a0a5e1be-3001-4814-84e2-fd3147b70200"
          }
        },
        "verificationMethod": {
          "ssn": null,
          "phone": null,
          "birthDate": null,
          "fullName": {
            "firstName": null,
            "middleName": null,
            "lastName": null
          },
          "address": {
            "line1": null,
            "line2": null,
            "city": null,
            "state": null,
            "country": null,
            "zipCode": null
          }
        },
        "status": {
          "ssn": "valid",
          "phone": "valid",
          "birthDate": "valid",
          "fullName": {
            "firstName": "valid",
            "middleName": "valid",
            "lastName": "valid"
          },
          "address": {
            "line1": "valid",
            "line2": "valid",
            "city": "valid",
            "state": "valid",
            "country": "valid",
            "zipCode": "valid"
          }
        },
        "expirationDate": {
          "ssn": null,
          "phone": null,
          "birthDate": null,
          "fullName": {
            "firstName": null,
            "middleName": null,
            "lastName": null
          },
          "address": {
            "line1": null,
            "line2": null,
            "city": null,
            "state": null,
            "country": null,
            "zipCode": null
          }
        }
      }
    }
  }
}

Content-Type

application/json