Skip to main content
POST
/
v2
/
link
/
init
Initialize a Link session
curl --request POST \
  --url https://api-next.ofauth.com/v2/link/init \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "redirectUrl": "<string>",
  "clientReferenceId": "<string>",
  "connectionId": "<string>",
  "geolocation": {
    "country": "<string>",
    "state": "<string>",
    "city": "<string>"
  }
}
'
{
  "url": "<string>",
  "expiresAt": "<string>"
}

Authorizations

​
apiKey
string
header
required

Your OFAuth API key for authenticating requests.

Body

application/json
​
redirectUrl
string<uri>

URL to redirect to after completion. If omitted, uses first allowed redirect URI.

​
clientReferenceId
string

Your internal reference ID for webhook correlation.

​
connectionId
string

Existing connection ID to reconnect.

​
geolocation
object

Response

Link session initialized successfully

​
url
string
required

URL to redirect the user to

​
expiresAt
string
required

ISO timestamp when the session expires