https://plaid.com/_next/static/chunks/pages/docs/api/products/layer-d150743695458660.js

1try{let e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="4cf1e922-020c-4db5-b3c8-4a4476ee688d",e._sentryDebugIdIdentifier="sentry-dbid-4cf1e922-020c-4db5-b3c8-4a4476ee688d")}catch(e){}(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[61353],{59810:function(e,n,t){"use strict";t.r(n),t.d(n,{default:function(){return m},metadata:function(){return l},tableOfContents:function(){return _}});var s=t(36864),a=t(4730);t(67294);var r=t(3905),o=t(47608),i=["components"],l={toc:!0,subnav:!0,maxTocLevel:4,layout:"reference",secondLevelToc:!0,alwaysExpand:!0,parentTocLevel:3,childTocLevel:4,description:"API reference for endpoints associated with the Plaid Layer product.",source:"endpoint"},c=function(e){return function(n){return console.warn("Component "+e+" was not imported, exported, or provided by MDXProvider as global scope"),(0,r.kt)("div",n)}},u=c("Header"),d=c("Schema"),p=c("MDXCodeBlock"),k={metadata:l};function m(e){var n=e.components,t=(0,a.Z)(e,i);return(0,r.kt)("wrapper",(0,s.Z)({},k,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)(u,{title:"Layer",subtitle:"API reference for Layer endpoints",compact:!0,mdxType:"Header"}),(0,r.kt)("p",null,"For how-to guidance, see the ",(0,r.kt)("a",{parentName:"p",href:"/docs/layer/"},"Layer documentation"),"."),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Endpoints"),(0,r.kt)("th",{parentName:"tr",align:null}))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"/session/token/create")),(0,r.kt)("td",{parentName:"tr",align:null},"Creates a Link token for a Layer session")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"/user_account/session/get")),(0,r.kt)("td",{parentName:"tr",align:null},"Returns user permissioned account data")))),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Webhooks"),(0,r.kt)("th",{parentName:"tr",align:null}))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"#layer_authentication_passed"},(0,r.kt)("inlineCode",{parentName:"a"},"LAYER_AUTHENTICATION_PASSED"))),(0,r.kt)("td",{parentName:"tr",align:null},"A user has been authenticated")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("a",{parentName:"td",href:"#session_finished"},(0,r.kt)("inlineCode",{parentName:"a"},"SESSION_FINISHED"))),(0,r.kt)("td",{parentName:"tr",align:null},"A Layer session has finished")))),(0,r.kt)("h3",{id:"endpoints"},"Endpoints"),(0,r.kt)("h4",{id:"sessiontokencreate"},"/session/token/create"),(0,r.kt)(d,{method:"POST",route:"/session/token/create",type:"request",mdxType:"Schema"},(0,r.kt)(p,{type:"server",title:"/session/token/create",mdxType:"MDXCodeBlock"},(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-node"},"const request: SessionTokenCreateRequest = {\n  user: {\n    client_user_id: 'user-abc'\n  },\n  template_id: 'template_4uinBNe4B2x9'\n};\ntry {\n  const response = await client.sessionTokenCreate(request);\n  const linkToken = response.data.link.link_token;\n} catch (error) {\n  // handle error\n}\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},'curl -X POST https://sandbox.plaid.com/session/token/create \\\n-H \'Content-Type: application/json\' \\\n-d \'{\n  "client_id": <ClientQD>"${PLAID_CLIENT_ID}"</ClientQD>,\n  "secret": <SecretQD>"${PLAID_SECRET}"</SecretQD>,\n  "user": {\n    "client_user_id": "user-abc"\n  },\n  "template_id": "template_4uinBNe4B2x9"\n}\'\n')),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"request = Plaid::SessionTokenCreateRequest.new(\n  {\n    user: {\n      client_user_id: 'user-abc'\n    },\n    template_id: 'template_4uinBNe4B2x9'\n  }\n)\nresponse = client.session_token_create(request)\nlink_token = response.link.link_token\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-java"},'SessionTokenCreateRequestUser user = new SessionTokenCreateRequestUser()\n  .clientUserId("user-abc");\n\nSessionTokenCreateRequest request = new SessionTokenCreateRequest()\n  .user(user)\n  .templateId("template_4uinBNe4B2x9");\n\nResponse<SessionTokenCreateResponse> response = client()\n  .sessionTokenCreate(request)\n  .execute();\n\nString linkToken = response.body().getLink().getLinkToken();\n')),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-python"},"request = SessionTokenCreateRequest(\n  user=SessionTokenCreateRequestUser(\n    client_user_id='user-abc'\n  ),\n  template_id='template_4uinBNe4B2x9'\n)\nresponse = client.session_token_create(request)\nlink_token = response['link']['link_token']\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-go"},'user := plaid.SessionTokenCreateRequestUser{\n  ClientUserId: "user-abc",\n}\n\nrequest := plaid.NewSessionTokenCreateRequest("template_4uinBNe4B2x9")\nrequest.SetUser(user)\n\nresponse, _, err := client.PlaidApi.\n  SessionTokenCreate(ctx).\n  SessionTokenCreateRequest(*request).\n  Execute()\nif err != nil {\n  panic(err)\n}\nlink := response.GetLink()\nlinkToken := link.GetLinkToken();\n')))),(0,r.kt)(d,{method:"POST",route:"/session/token/create",type:"response",mdxType:"Schema"}),(0,r.kt)("h4",{id:"user_accountsessionget"},"/user_account/session/get"),(0,r.kt)(d,{method:"POST",route:"/user_account/session/get",type:"request",mdxType:"Schema"},(0,r.kt)(p,{type:"server",title:"/user_account/session/get",mdxType:"MDXCodeBlock"},(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-node"},"const request: UserAccountSessionGetRequest = {\n  public_token: 'profile-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce992d',\n};\ntry {\n  const response = await client.userAccountSessionGet(request);\n} catch (error) {\n  // handle error\n}\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},'curl -X POST https://sandbox.plaid.com/user_account/session/get \\\n-H \'Content-Type: application/json\' \\\n-d \'{\n  "public_token": "profile-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce992d",\n  "client_id": <ClientQD>"${PLAID_CLIENT_ID}"</ClientQD>,\n  "secret": <SecretQD>"${PLAID_SECRET}"</SecretQD>\n}\'\n')),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ruby"},"request = Plaid::UserAccountSessionGetRequest.new(\n  {\n    public_token: 'profile-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce992d'\n  }\n)\nresponse = client.user_account_session_get(request)\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-java"},'\nUserAccountSessionGetRequest request = new UserAccountSessionGetRequest

1()\n  .publicToken("profile-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce992d");\n\nResponse<UserAccountSessionGetResponse> response = client()\n  .userAccountSessionGet(request)\n  .execute();\n')),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-python"},"request = UserAccountSessionGetRequest(\n    public_token='profile-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce992d'\n)\nresponse = client.user_account_session_get(request)\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-go"},'request := plaid.NewUserAccountSessionGetRequest(\n  "profile-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce992d",\n)\n\nresponse, _, err := client.PlaidApi.\n  UserAccountSessionGet(ctx).\n  UserAccountSessionGetRequest(*request).\n  Execute()\n')))),(0,r.kt)(d,{method:"POST",route:"/user_account/session/get",type:"response",mdxType:"Schema"}),(0,r.kt)("h3",{id:"webhooks"},"Webhooks"),(0,r.kt)("h4",{id:"layer_authentication_passed"},(0,r.kt)("inlineCode",{parentName:"h4"},"LAYER_AUTHENTICATION_PASSED")),(0,r.kt)(d,{model:"LayerAuthenticationPassedWebhook",type:"model",mdxType:"Schema"}),(0,r.kt)("h4",{id:"session_finished"},(0,r.kt)("inlineCode",{parentName:"h4"},"SESSION_FINISHED")),(0,r.kt)(d,{model:"LinkSessionFinishedWebhook",type:"model",mdxType:"Schema"}))}m.isMDXComponent=!0;var _=[{id:"endpoints",level:3,title:"Endpoints"},{id:"sessiontokencreate",level:4,title:"/session/token/create"},{id:"user_accountsessionget",level:4,title:"/user_account/session/get"},{id:"webhooks",level:3,title:"Webhooks"},{id:"layer_authentication_passed",level:4,title:"LAYER_AUTHENTICATION_PASSED"},{id:"session_finished",level:4,title:"SESSION_FINISHED"}];k.tableOfContents=_,m.layoutProps=k,m.layout=function(e){return(0,r.kt)(o.Z,e)}},69529:function(e,n,t){(window.__NEXT_P=window.__NEXT_P||[]).push(["/docs/api/products/layer",function(){return t(59810)}])}},function(e){e.O(0,[49774,86898,26736,29622,12291,22359,68239,79255,92888,40179],function(){return e(e.s=69529)}),_N_E=e.O()}]);
2//# sourceMappingURL=layer-d150743695458660.js.map