ChallengesDocs

Register

Get a Round 2 API key

Register

POST /api/v2/register

Round 2 uses its own API keys, which start with ec2_. Round 1 keys don't work on /api/v2 endpoints. If you played Round 1, register with the same email so we can connect your results.

Request Body

All fields are required.

FieldTypeNotes
aliasstring3-30 letters, numbers or underscores
namestringYour full name, 2-100 characters
emailstringYour API key is sent here
countrystringISO 3166-1 alpha-2 code, e.g. US, PR, MX
resume_urlstringhttps:// link to your resume (Drive, Dropbox, site)
linkedin_urlstringhttps:// link on linkedin.com
github_urlstringhttps:// link on github.com
profile_image_urlstringPublic https:// URL to an image in an AWS S3 bucket, shown on the leaderboard

Links can be at most 300 characters.

{
  "alias": "ada_lovelace",
  "name": "Ada Lovelace",
  "email": "ada@example.com",
  "country": "US",
  "resume_url": "https://drive.google.com/file/d/abc123/view",
  "linkedin_url": "https://www.linkedin.com/in/ada-lovelace",
  "github_url": "https://github.com/ada-lovelace",
  "profile_image_url": "https://ada-lovelace.s3.amazonaws.com/avatar.png"
}

Responses

201

{
  "message": "Registration successful. Check your email for your Round 2 API key.",
  "alias": "ada_lovelace"
}

400

A missing field lists exactly which ones:

{
  "error": "MISSING_FIELDS",
  "message": "Missing required fields: name, github_url",
  "missing": ["name", "github_url"]
}

A malformed field returns its own error code: INVALID_ALIAS, INVALID_NAME, INVALID_EMAIL, INVALID_COUNTRY_CODE, INVALID_RESUME_URL, INVALID_LINKEDIN_URL, INVALID_GITHUB_URL or INVALID_PROFILE_IMAGE_URL.

{
  "error": "INVALID_LINKEDIN_URL",
  "message": "linkedin_url must be an https://linkedin.com link of at most 300 characters"
}

409

{
  "error": "EMAIL_EXISTS",
  "message": "This email is already registered"
}

Using Your Key

Send the key in the API-KEY header on every other Round 2 request:

curl https://equiply.io/api/v2/hospitals -H "API-KEY: ec2_..."