Validate a user invite

Request

Check if a user's invite is still valid. This operation is useful to avoid having the user fill in a form only to be held by a validation issue (eg. expired invite).

Security

apiKey

Path

user_idstring^[0-9]+$required

The unique identifier for the user.

Example:110747174434373672

idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Bodyapplication/jsonrequired

inviteCodestring, = 6 characters^[0-9]*$required

A randomly generated one-time use code.

curl -i -X POST \
  https://sandbox.weavr.io/payment-run/v1/users/110747174434373672/invite/validate \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string' \
  -d '{
    "inviteCode": "string"
  }'

Responses

Success - No Content.

Headers

request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Response

No content