Skip to main content

Post a request to the device endpoint to retrieve a token

POST 
/device/auth

Post a request to the device endpoint to retrieve a 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

Reference authority request

    AuthorityName stringrequired

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    The ID of the Authority i.e GBFCA, etc

    AuthorityCode stringrequired

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[^<>]*$

    Code of the Authority i.e. GBFCA, etc

    AuthorityUri stringrequired

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    URI of the authority

    AuthorityCountry stringrequired

    Possible values: >= 2 characters and <= 255 characters, Value must match regular expression ^[^<>]*$

    Country of the authority

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Responses​

Get a reference authority by Id

Response Headers

  • x-fapi-interaction-id

    string

Schema

    AuthorityId AuthorityId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the Authorisation reference schema

    AuthorityName string

    Possible values: <= 255 characters

    Name of the Authority i.e. FCA, etc

    AuthorityCode string

    Possible values: <= 40 characters

    Code of the Authority i.e. FCA, etc

    AuthorityUri string

    Possible values: Value must match regular expression ^[^<>]*$

    URI of the authority

    AuthorityCountry string

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    country of the Authority

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Loading...