linkTokenCreate

POST {{baseUrl}}/link/token/create

The /link/token/create endpoint creates a link_token, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a public_token, which can then be exchanged for an access_token via /item/public_token/exchange as part of the main Link flow.

A link_token generated by /link/token/create is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.

Request Body

{"client_name"=>"<string>", "language"=>"<string>", "country_codes"=>["<string>"], "user"=>{"client_user_id"=>"<string>", "legal_name"=>"<string>", "phone_number"=>"<string>", "phone_number_verified_time"=>"<string>", "email_address"=>"<string>", "email_address_verified_time"=>"<string>", "ssn"=>"<string>", "date_of_birth"=>"<string>"}, "products"=>["<string>"], "webhook"=>"<string>", "access_token"=>"<string>", "link_customization_name"=>"<string>", "redirect_uri"=>"<string>", "account_filters"=>{"depository"=>{"account_subtypes"=>["<string,number>", "<string,number>"]}, "credit"=>{"account_subtypes"=>["<string,number>", "<string,number>"]}}, "institution_id"=>"<string>", "auth"=>{"flow_type"=>"<string>"}, "transfer"=>{"intent_id"=>"<string>"}, "update"=>{"account_selection_enabled"=>false}}

HEADERS

RESPONSES

status: OK

{"link_token":"\u003cstring\u003e","expiration":"\u003cstring\u003e","request_id":"\u003cstring\u003e"}