Quickstart

Create your first entity in five minutes, then read back its Entity 360.

1. Choose an environment

Youverify provides separate sandbox (test data) and production (live, billed) environments, each with its own base URL and credentials shown in your workspace at https://cowork.youverify.co/. For more information on the different environment, See here

2. Authenticate

Pass your secret key in the token header on every server-to-server call. For more information on how to generate your API Key, See here

token: <YOUR_SECRET_API_KEY>
Content-Type: application/json

3. Create an entity (minimal data)

curl -X POST "{{baseUrl}}/v2/api/entities" \
  -H "token: $YV_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "individual",
    "isSubjectConsent": true,
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "[e-mail]"
  }'

4. Read the entity 360

curl-X GET "{{baseUrl}}/v2/api/entities/ent_685c73c8519d82bd21a42fae"
  -H "token: $YV_SECRET_KEY"