HEhevn-inc
auth

Start a developer-key login and receive the payload to sign

Changed on

Start developer-key authentication. Sign the returned payload with the registered key and exchange it once through POST /auth/token before it expires.

post/auth/challenge

Request

Request body

emailstring email required

Email address of the account that owns the registered developer key.

publicKeystring required

Base64 DER SubjectPublicKeyInfo for the registered P-256 developer key.

nonceinteger required

Caller-generated single-use number included in the signed authentication proof.

requestExpiryinteger required

Unix time in milliseconds after which the signed request is refused.

signaturestring required

Base64 DER ECDSA P-256/SHA-256 signature over the login proof message.

Response

Successful Response

challengeIdstring uuid required

Single-use authentication challenge identifier.

payloadstring required

Base64-encoded canonical authorization payload the developer key must sign.

expiresAtstring date-time required

UTC timestamp after which the challenge is refused.

Changes

  • 299a3aa6f521Revision changes
    • warning

      added the new verification_not_applicable enum value to the / response property for the response status

    • info

      removed the phone_required enum value from the / response property for the response status

    • info

      removed the rail_requirements_unmet enum value from the / response property for the response status

  • a02795de2d2bRevision changes
    • warning

      deleted the header request parameter x-api-key

    • warning

      added the new client_already_linked enum value to the / response property for the response status

    • warning

      added the new kyb_documents_processing enum value to the / response property for the response status

    • warning

      added the new link_code_expired enum value to the / response property for the response status

    • warning

      added the new link_code_invalid enum value to the / response property for the response status

    • warning

      added the new payout_not_awaiting_signature enum value to the / response property for the response status

    • warning

      added the new redirect_uri_not_allowed enum value to the / response property for the response status

    • warning

      added the new sandbox_amount_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new sandbox_faucet_balance_too_high enum value to the / response property for the response status

    • info

      removed the client_policy_not_enabled enum value from the / response property for the response status

    • info

      removed the client_request_conflict enum value from the / response property for the response status

    • info

      removed the email_in_use enum value from the / response property for the response status

    • info

      removed the integrator_inactive enum value from the / response property for the response status

    • info

      removed the name_in_use enum value from the / response property for the response status