Skip to main content

Post a request to the token endpoint to retrieve a token

POST 
/token

exchange a code for an access token

Request​

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Body

required

Client Access Token Request

    grant_type stringrequired

    Possible values: non-empty, [client_credentials, private_key_jwt, tls_client_auth, urn:ietf:params:oauth:grant-type:device_code]

    Default value: client_credentials

    The Grant Type

    client_id string

    Possible values: non-empty and <= 255 characters

    Required with grant_type private_key_jwt

    client_assertion_type string

    Possible values: non-empty and <= 160 characters, [urn:ietf:params:oauth:client-assertion-type:jwt-bearer]

    Required with grant_type private_key_jwt

    assertion string

    Possible values: non-empty

    The assertion that is used to get a token, required with grant_type private_key_jwt

Responses​

Access token response

Response Headers

  • x-fapi-interaction-id

    string

Schema

    access_token string

    Access token

    expires_in integer

    lifetime in seconds

    token_type string
    scope string
Loading...