Sign up and sign in

Before you call the API you need a Vindex account. Create one, sign in to the Developers console, open developer access for your company, and invite the people who build with you.

People and servers

People sign inWith an email address and password, to the Developers console: keys, webhooks, logs, credits and team.

Servers use keysEvery API request carries a secret key. The API never takes a password, and there is no sign-in call to make.

Each person on your team signs in with their own account. Your servers never sign in: they send a key, as described in Keys, limits and conventions.

Create an account

1
Open vindexgrid.com/app/register, or press Sign in on any Vindex page and then Create an account.
2
Enter your work email address, a password (twice), your name and your mobile number, then press Create account.
3
Vindex emails you a 6-digit confirmation code. Type it on the confirmation page and press Confirm my email. Closed the page? Open vindexgrid.com/app/verify, or press Have a code? Confirm your email under the sign-in form.
4
Sign in with your email address and password.

Use an address your company keeps

The account that opens developer access becomes its owner. Use a work address that will outlive any one job, and invite colleagues rather than sharing one sign-in.

1
Open vindexgrid.com/app/login. Under the form, check that it says you are signing in to the Customer workspace; if not, press Change and pick it.
2
Type your email address and password and press Sign in. If your account uses a second sign-in step, Vindex then asks for a 6-digit code.
3
Open the Developers console: Developers in the bar on the left.

Not confirmed yet

Vindex asks you to confirm your email first. Use the code from the email it sent when you made the account.

Wrong email or password

Vindex says only that the two don't match, never which one is wrong. Check both, or reset your password.

Signed out after a while

Sign-ins expire. Sign in again; nothing you saved is lost. Your API keys are not affected: they keep working until you revoke them.

Open developer access

The first time you open the Developers console it offers developer access for your company. It takes a few seconds.

1
Enter your company or product name, your country (2 letters, such as IN) and, if you like, your website.
2
Press Open developer access. Vindex creates your developer account in test mode, with free test credits, and shows your first test key (vdx_test_…).
3
Copy the key into your secrets store now: it is shown once. You can create more keys at any time under API keys.

Customer accounts only

Developer access belongs to customer accounts, and each person can open it once. Live keys come later, when Vindex approves your company: see Go live.

Invite your team

In the console, open Settings, then Team. Enter a colleague's email address, choose a role and press Invite. If they already have a Vindex account they join at once; if not, they join as soon as they sign up with that address. Owners and admins can change a role or remove someone at any time.

Role	Can
Owner	Everything. The person who opened developer access; can't be removed, and is the only one who can add admins.
Admin	The team, test and live keys, webhooks, credits and billing, settings, and the application to go live.
Developer	Test keys and webhooks, the request log with request bodies, and usage. Can't create live keys.
Billing	Credits, auto-recharge, invoices and usage limits. Sees usage; no keys or webhooks.
Viewer	Reads everything in the console and changes nothing.

Vindex staff accounts can't join a partner team; invite your colleagues with their own work addresses.

Confirm it is you

A few changes touch your live account, so the console asks for your password again before it makes them, even though you are signed in:

creating a live key, or rolling one;
showing or rolling the signing secret of a live webhook endpoint.

Type your password (and your code, if your account uses one) in the Confirm it is you window. The check lasts 10 minutes, so a few changes in a row ask only once. Test keys and test endpoints never ask.

Forgotten password

1
On the sign-in page press Forgot password?, or open vindexgrid.com/app/reset.
2
Enter your email address and press Email me a code.
3
Enter the code from the email and a new password, press Save new password, then sign in with it.

Lost access to the email address itself? Ask your company's owner or an admin to invite your new address, and tell Vindex support so the old account can be closed.

Every step above is also an API call, for building your own sign-up screen or scripting test accounts. These calls are on the Vindex app API, https://api.vindexgrid.com (not under /v1), and take no API key. The tokens they return sign a person in to Vindex and the Developers console; the /v1 API accepts only API keys.

Call	Send	Get back
Create an account`POST /auth/register`	`email`, `password`, `display_name`, `phone`. For a company add `signup_type: "organization"`, `organization_name` and `organization_country` (2 letters).	`account.email` and `verification.delivery: "email"`: Vindex emails a 6-digit code.
Confirm the email`POST /auth/verify-email`	`email`, `code`	`email_verified: true`
Sign in`POST /auth/login`	`email`, `password`, and `mfa_code` if the account has a second step	`status`, `access_token`, `refresh_token`, `token_type`, `expires_at` and `user` (`id`, `email`, `display_name`)
Ask for a reset code`POST /auth/password-reset/request`	`email`	`delivery: "email"`: Vindex emails a reset code.
Set a new password`POST /auth/password-reset/confirm`	`email`, `token` (the code from the email), `new_password`	`ok: true`

# 1. Create the account (Vindex emails a 6-digit code)
curl https://api.vindexgrid.com/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "dev@acme.example", "password": "a-long-passphrase", "display_name": "Asha Rao", "phone": "+91 98765 43210"}'

# 2. Confirm the email with the code
curl https://api.vindexgrid.com/auth/verify-email \
  -H "Content-Type: application/json" \
  -d '{"email": "dev@acme.example", "code": "482913"}'

# 3. Sign in
curl https://api.vindexgrid.com/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "dev@acme.example", "password": "a-long-passphrase"}'

Using the token

Send access_token as Authorization: Bearer … to the app API until expires_at, then sign in again.

Errors

Errors are JSON with a detail message: 401 wrong email or password, 403 email not confirmed or a password reset required, 409 an account already exists for that email, 422 a wrong or expired code.

Second sign-in step

If status is not authenticated, the account still has its second step to finish: send the 6-digit code as mfa_code with the email and password.

Accounts are for your team, not your customers

Never collect or store your customers' Vindex passwords. To verify a customer, create a verification: they complete Vindex's hosted flow without an account.

When someone leaves

Remove them

Settings → Team, then remove the person. They lose the console at once; the Audit log keeps what they did.

Roll the keys they saw

Keys belong to your company, not to a person, so removing someone doesn't stop a key they copied. Roll any key they could have seen, with an overlap so your servers switch without downtime.

If the owner leaves

The owner can't be removed in the console. Contact Vindex support before they go, so your company keeps an owner.

Keys, limits and conventionsAPI keys, test and live mode, versions, request ids, rate limits, safe retries, paging and metadata.Go liveApply for live access, the checklist before you switch, and what stays your responsibility.Test modeBuild and test for free: simulated outcomes, test names, test credits and test helpers.Credits and billingHow prepaid credits work: prices, holds and charges, buying, auto-recharge, expiry and refunds.

Something missing or unclear? Signed-in users can tell us from Feedback in the app.