Skip to main content
POST
Exchanges the single-use verification_code returned by Verify a one-time code for a user’s tokens, using the urn:openloophealth:oauth:grant-type:verification-code grant. This is the last call in the required part of the User Registration flow — from here the user authenticates with their own tokens. Permissions: None
string
required
Must be urn:openloophealth:oauth:grant-type:verification-code.
string
required
verification_code from POST /auth/verify-otp.
string
required
Must be the same client that requested the OTP.
string
required
Your client secret.
object
required
string
required
Correlation id echoed on every response.

Body

application/json

Fields required depend on grant_type: client_credentials also requires audience; the verification-code grant also requires code; refresh_token also requires refresh_token.

grant_type
enum<string>
required
Available options:
client_credentials,
urn:openloophealth:oauth:grant-type:verification-code,
refresh_token
client_id
string
required
client_secret
string
required
audience
string

Required for the client_credentials grant.

code
string

Verification code from POST /auth/verify-otp. Required for the verification-code grant.

refresh_token
string

Required for the refresh_token grant.

Response

OK

data
object
required
request_id
string<uuid>
required

Correlation id echoed on every response.