Retrieve a person

get https://app.standardcode.io/api/v1/people/{key}

Get a person specified by the input key.

Responses

Response body

object

key

string

required

The key (ID) to use to retrieve the underlying object from the API.

created_at

float

required

The time at which the object was created, expressed as a Unix timestamp with microseconds.

modified_at

float

required

The time at which the object was last modified, expressed as a Unix timestamp with microseconds.

object

The email address of the person. Note that the email can be verified.

string

required

The email of the person. All emails will follow the format defined in the W3C HTML5 spec.

verified

boolean

required

Indicates whether or not the data on this object has been verified.

verify_status

string

required

Indicates the status of the verification.

not_started means that the verification process has not been started.
processing means that the verification process has started but no results have come back.
succeeded means that the data has been verified. In this case, verified should also be set to true.
failed means that the verification process finished but the data was not able to be verified.
reset means that the previous verification results have been discarded.

not_started processing succeeded failed reset

last_verified_at

float

The time at which the data was last verified, expressed as a Unix timestamp with microseconds. This property will only be set if the data was successfully verified at some point in the past.

phone

object

The phone number of the person. Note that the phone can be verified.

phone

string

required

The phone number of the person. All phone numbers will be in E.164 format.

verified

boolean

required

Indicates whether or not the data on this object has been verified.

verify_status

string

required

Indicates the status of the verification.

not_started means that the verification process has not been started.
processing means that the verification process has started but no results have come back.
succeeded means that the data has been verified. In this case, verified should also be set to true.
failed means that the verification process finished but the data was not able to be verified.
reset means that the previous verification results have been discarded.

not_started processing succeeded failed reset

last_verified_at

float

The time at which the data was last verified, expressed as a Unix timestamp with microseconds. This property will only be set if the data was successfully verified at some point in the past.

name

object

The name of the person, split into first, middle and last names. Note that the name can be verified.

first_name

string

required

The first name of the person.

middle_name

string

The middle name of the person.

last_name

string

required

The first name of the person.

verified

boolean

required

Indicates whether or not the data on this object has been verified.

verify_status

string

required

Indicates the status of the verification.

not_started means that the verification process has not been started.
processing means that the verification process has started but no results have come back.
succeeded means that the data has been verified. In this case, verified should also be set to true.
failed means that the verification process finished but the data was not able to be verified.
reset means that the previous verification results have been discarded.

not_started processing succeeded failed reset

last_verified_at

float

The time at which the data was last verified, expressed as a Unix timestamp with microseconds. This property will only be set if the data was successfully verified at some point in the past.

birthday

object

The birthday of the person. Note that the birthday can be verified.

birthday

string

required

The birthday of the person, formatted as an ISO string e.g. "YYYY-MM-DD".

verified

boolean

required

Indicates whether or not the data on this object has been verified.

verify_status

string

required

Indicates the status of the verification.

not_started means that the verification process has not been started.
processing means that the verification process has started but no results have come back.
succeeded means that the data has been verified. In this case, verified should also be set to true.
failed means that the verification process finished but the data was not able to be verified.
reset means that the previous verification results have been discarded.

not_started processing succeeded failed reset

last_verified_at

float

The time at which the data was last verified, expressed as a Unix timestamp with microseconds. This property will only be set if the data was successfully verified at some point in the past.

location

object

The geographic location of the person. Note that the location can be verified.

country_code

string

required

The country of the person. All country codes will be two letter country codes.

verified

boolean

required

Indicates whether or not the data on this object has been verified.

verify_status

string

required

Indicates the status of the verification.

not_started means that the verification process has not been started.
processing means that the verification process has started but no results have come back.
succeeded means that the data has been verified. In this case, verified should also be set to true.
failed means that the verification process finished but the data was not able to be verified.
reset means that the previous verification results have been discarded.

not_started processing succeeded failed reset

last_verified_at

float

The time at which the data was last verified, expressed as a Unix timestamp with microseconds. This property will only be set if the data was successfully verified at some point in the past.

guardian_keys

array of strings

A list of string keys, where each key represents a person object that is a guardian of the child.

guardian_keys

requires_parental_consent

boolean

Indicates whether or not the child requires parental consent to use your application because they are under the age of digital consent. This property will only be present if both the birthday and location properties are set.

parental_consent_obtained

boolean

Indicates whether or not parental consent has been obtained for this child. This property only has meaning if requires_parental_consent is true.

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.standardcode.io/api/v1/people/key \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The person associated with the input key.

404The specified key does not resolve to a person.