click-entity-example
1ClickEntity Example
{
"identifiers": {
"phone": "+10123456789"
},
"credentials": {
// Multiple emails because `multi` was set to `true` in the email credential request
"email": [
"richard@piedpiper.net",
"richard@hooli.com"
],
"fullName": {
"firstName": "Richard",
"lastName": "Hendricks"
},
// Multiple addresses because `multi` was set to `true` in the address credential request
"address": [
{
"line1": "5320 Newell Rd",
"city": "Palo Alto",
"state": "CA",
"zipCode": "94303",
"country": "US"
},
{
"line1": "9536 Meadow Dr",
"line2": "Apt 301",
"city": "San Francisco",
"state": "CA",
"zipCode": "94112",
"country": "US"
},
{
"line1": "7292 Hanover St",
"city": "San Jose",
"state": "CA",
"zipCode": "95122",
"country": "US"
}
],
"birthDate": "1989-08-01",
"ssn": "123456789"
},
"metadata": {
"identifiers": {
"verificationMethod": {
"phone": "otp"
}
},
// Follows the same structure as `credentials` and maintains the same order for array items when `multi` is set to `true`
"credentials": {
"id": {
// e.g. Follows the same structure as the email credential and maintains the same order for array items
"email": [
"8a1d4e35-413d-496b-b499-8810b55cfb5c",
"b82e39cf-3bb6-4105-b9c1-bfd1ed2a4dbc"
]
"fullName": {
"firstName": "2e6a7b9a-e93e-43ba-98a9-c554f4e16457",
"lastName": "9a5817ef-e621-4277-8c48-c8ee3776b6c4"
},
// e.g. Follows the same structure as the address credential and maintains the same order for array items
"address": [
{
"line1": "f5a4dc93-bc06-4bb8-bd05-17b5ba912bcd",
"city": "efd3820f-676a-4db1-b63e-695b66ed8ba0",
"state": "b65022a2-2016-41df-88f3-252e8e3a29c5",
"zipCode": "b747ff84-39d8-4df9-98f9-24a465f1a9ae",
"country": "d57a7bca-2a7c-4671-86ad-5647731cad02"
},
{
"line1": "6c7350bd-ea84-485b-baa8-fba3381cc859",
"line2": "5311e2c8-67a1-4fe4-8ddb-88dc8a900915",
"city": "c315d4ed-34c6-41a9-b7ca-c17cb4bac927",
"state": "e3774b5f-0996-4dc7-a9b3-8ad24c9a286c",
"zipCode": "abc2e42c-2864-4bf6-b262-05cb51416957",
"country": "fca7d486-c99b-436e-9a92-95e221e4ba5d"
},
{
"line1": "afdaca85-4abe-4c0d-910d-7f48261bcbe0",
"city": "cf17d0d8-08f3-4205-82a9-812a0be747da",
"state": "b1480256-bd81-4ed5-a748-62890304a2e3",
"zipCode": "62d14d62-bd4e-4175-8a0d-01f21a22d833",
"country": "baff8fea-34cd-451c-9324-ca0cf1582dd7"
}
],
"birthDate": "ec1ef0ce-eeed-46a4-94a9-29b46e64403d",
"ssn": "ec1ef0ce-eeed-46a4-94a9-29b46e64403d"
},
"verificationMethod": {
"email": [
"self_attested",
"credit_bureau"
]
"fullName": {
"firstName": "phone_carrier",
"lastName": "phone_carrier"
},
"address": [
{
"line1": "credit_bureau",
"city": "credit_bureau",
"state": "credit_bureau",
"zipCode": "credit_bureau",
"country": "credit_bureau"
},
{
"line1": "credit_bureau",
"line2": "credit_bureau",
"city": "credit_bureau",
"state": "credit_bureau",
"zipCode": "credit_bureau",
"country": "credit_bureau"
},
{
"line1": "phone_carrier",
"city": "phone_carrier",
"state": "phone_carrier",
"zipCode": "phone_carrier",
"country": "phone_carrier"
}
],
"birthDate": "phone_carrier",
"ssn": "phone_carrier"
},
"status": {
"email": [
"valid",
"valid"
],
"fullName": {
"firstName": "valid",
"lastName": "valid"
},
"address": [
{
"line1": "valid",
"city": "valid",
"state": "valid",
"zipCode": "valid",
"country": "valid"
},
{
"line1": "valid",
"line2": "valid",
"city": "valid",
"state": "valid",
"zipCode": "valid",
"country": "valid"
},
{
"line1": "valid",
"city": "valid",
"state": "valid",
"zipCode": "valid",
"country": "valid"
}
],
"birthDate": "valid",
"ssn": "valid"
},
"expirationDate": {
"email": [
"1871839024044",
"1885082680000"
],
"fullName": {
"firstName": "1871839024044",
"lastName": "1871839024044"
},
"address": [
{
"line1": "1871839024044",
"city": "1871839024044",
"state": "1871839024044",
"zipCode": "1871839024044",
"country": "1871839024044"
},
{
"line1": "1871839024044",
"line1": "1871839024044",
"city": "1871839024044",
"state": "1871839024044",
"zipCode": "1871839024044",
"country": "1871839024044"
},
{
"line1": "1875924280000",
"city": "1875924280000",
"state": "1875924280000",
"zipCode": "1875924280000",
"country": "1875924280000"
},
],
"birthDate": null,
"ssn": null
}
}
}
}