Skip to main content
GET
Read native Make Credential Request status

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
grant_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
request_id
string
required
Pattern: ^[a-f0-9]{64}$

Response

Current Credential Request status.

state
enum<string>
required
Available options:
created,
running,
uncertain,
reconnect_required
request_id
string
Pattern: ^[a-f0-9]{64}$
provider_status
string
Required string length: 1 - 64
expires_at
string<date-time> | null