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]="0559f693-870e-4764-874e-cdc8ab5efe8b",e._sentryDebugIdIdentifier="sentry-dbid-0559f693-870e-4764-874e-cdc8ab5efe8b")}catch(e){}(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[39215],{3062:function(e,n,t){"use strict";t.r(n),t.d(n,{default:function(){return _},metadata:function(){return l},tableOfContents:function(){return S}});var r=t(36864),a=t(4730);t(67294);var i=t(3905),o=t(47608),s=t(76826),d=["components"],l={toc:!0,subnav:!0,maxTocLevel:4,layout:"reference",secondLevelToc:!0,alwaysExpand:!0,parentTocLevel:3,childTocLevel:4,description:"API reference for endpoints and webhooks associated with the Plaid Transfer for Platforms product.",source:"endpoint"},u=function(e){return function(n){return console.warn("Component "+e+" was not imported, exported, or provided by MDXProvider as global scope"),(0,i.kt)("div",n)}},c=u("Header"),p=u("Schema"),m=u("MDXCodeBlock"),f={metadata:l};function _(e){var n=e.components,t=(0,a.Z)(e,d);return(0,i.kt)("wrapper",(0,r.Z)({},f,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)(c,{title:"Transfer for Platforms",subtitle:"API reference for Transfer for Platforms endpoints",compact:!0,mdxType:"Header"}),(0,i.kt)("p",null,"For how-to guidance, see the ",(0,i.kt)("a",{parentName:"p",href:"/docs/transfer/platform-payments"},"Transfer for Platforms documentation"),"."),(0,i.kt)("div",{className:"long-endpoint-table"},(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:null},"Transfer for Platforms"),(0,i.kt)("th",{parentName:"tr",align:null}))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"/transfer/platform/originator/create")),(0,i.kt)("td",{parentName:"tr",align:null},"Pass transfer specific onboarding info for the originator")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"/transfer/platform/person/create")),(0,i.kt)("td",{parentName:"tr",align:null},"Create each individual who is a beneficial owner or control person of the business")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"/transfer/platform/requirement/submit")),(0,i.kt)("td",{parentName:"tr",align:null},"Pass additional data Plaid needs to make an onboarding decision for the originator")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"#transferplatformdocumentsubmit"},(0,i.kt)("inlineCode",{parentName:"a"},"/transfer/platform/document/submit"))),(0,i.kt)("td",{parentName:"tr",align:null},"Submit documents Plaid needs to verify information about the originator")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"/transfer/originator/get")),(0,i.kt)("td",{parentName:"tr",align:null},"Get the status of an originator's onboarding")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"/transfer/originator/list")),(0,i.kt)("td",{parentName:"tr",align:null},"Get the status of all originators' onboarding")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"/transfer/originator/funding_account/create")),(0,i.kt)("td",{parentName:"tr",align:null},"Create a new funding account for an originator"))))),(0,i.kt)("h4",{id:"transferplatformoriginatorcreate"},"/transfer/platform/originator/create"),(0,i.kt)(p,{method:"POST",route:"/transfer/platform/originator/create",type:"request",mdxType:"Schema"},(0,i.kt)(m,{type:"server",title:"/transfer/platform/originator/create",mdxType:"MDXCodeBlock"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-node"},'const request: TransferPlatformOriginatorCreateRequest = {\n originator_client_id: "6a65dh3d1h0d1027121ak184",\n tos_acceptance_metadata: {\n agreement_accepted: true,\n originator_ip_address: "192.0.2.42",\n agreement_accepted_at: "2017-09-14T14:42:19.350Z"\n },\n originator_reviewed_at: "2024-07-29T20:22:21Z",\n webhook: "https://webhook.com/webhook"\n};\n\ntry {\n const response = await client.transferPlatformOriginatorCreate(request);\n} catch (error) {\n // handle error\n}\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},'curl -X POST https://sandbox.plaid.com/transfer/platform/originator/create \\\n -H \'Content-Type: application/json\' \\\n -d \'{\n "client_id": <ClientQD>"${PLAID_CLIENT_ID}"</ClientQD>,\n "secret": <SecretQD>"${PLAID_SECRET}"</SecretQD>,\n "originator_client_id": "6a65dh3d1h0d1027121ak184",\n "tos_acceptance_metadata": {\n "agreement_accepted": true,\n "originator_ip_address": "192.0.2.42",\n "agreement_accepted_at": "2017-09-14T14:42:19.350Z"\n },\n "originator_reviewed_at": "2024-07-29T20:22:21Z",\n "webhook": "https://webhook.com/webhook"\n }\'\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'request = Plaid::TransferPlatformOriginatorCreateRequest.new(\n {\n originator_client_id: "6a65dh3d1h0d1027121ak184",\n tos_acceptance_metadata: {\n agreement_accepted: true,\n originator_ip_address: "192.0.2.42",\n agreement_accepted_at: "2017-09-14T14:42:19.350Z"\n },\n originator_reviewed_at: "2024-07-29T20:22:21Z",\n webhook: "https://webhook.com/webhook"\n }\n)\nresponse = client.transfer_platform_originator_create(request)\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-java"},'TransferPlatformTOSAcceptanceMetadata tosMetadata = new TransferPlatformTOSAcceptanceMetadata()\n .agreementAccepted(true)\n .originatorIpAddress("192.0.2.42")\n .agreementAcceptedAt(OffsetDateTime.parse("2017-09-14T14:42:19.350Z"));\n\nTransferPlatformOriginatorCreateRequest request = new TransferPlatformOriginatorCreateRequest()\n .originatorClientId("6a65dh3d1h0d1027121ak184")\n .tosAcceptanceMetadata(tosMetadata)\n .originatorReviewedAt(OffsetDateTime.parse("2024-0
17-29T20:22:21Z"))\n .webhook("https://webhook.com/webhook");\n\nResponse<TransferPlatformOriginatorCreateResponse> response = client()\n .transferPlatformOriginatorCreate(request)\n .execute();\n\nTransferPlatformOriginatorCreateResponse originator =\n response.body();\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'request = TransferPlatformOriginatorCreateRequest(\n originator_client_id="6a65dh3d1h0d1027121ak184",\n tos_acceptance_metadata={\n "agreement_accepted": True,\n "originator_ip_address": "192.0.2.42",\n "agreement_accepted_at": datetime.datetime(2017, 9, 14, 14, 42, 19, 350000, tzinfo=datetime.timezone.utc)\n },\n originator_reviewed_at=datetime.datetime(2024, 7, 29, 20, 22, 21),\n webhook="https://webhook.com/webhook"\n)\nresponse = client.transfer_platform_originator_create(request)\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-go"},'tosMetadata := plaid.TransferPlatformTOSAcceptanceMetadata{\n AgreementAccepted: true,\n OriginatorIpAddress: "192.0.2.42",\n AgreementAcceptedAt: time.Date(2017, 9, 14, 14, 42, 19, 350000000, time.UTC),\n}\n\nrequest := plaid.NewTransferPlatformOriginatorCreateRequest(\n "6a65dh3d1h0d1027121ak184",\n tosMetadata,\n time.Date(2024, 7, 29, 20, 22, 21, 0, time.UTC),\n)\nrequest.SetWebhook("https://webhook.com/webhook")\n\nresponse, _, err := client.PlaidApi.TransferPlatformOriginatorCreate(ctx).\n TransferPlatformOriginatorCreateRequest(*request).\n Execute()\n')))),(0,i.kt)(p,{method:"POST",route:"/transfer/platform/originator/create",type:"response",mdxType:"Schema"}),(0,i.kt)("h4",{id:"transferplatformpersoncreate"},"/transfer/platform/person/create"),(0,i.kt)(p,{method:"POST",route:"/transfer/platform/person/create",type:"request",mdxType:"Schema"},(0,i.kt)(m,{type:"server",title:"/transfer/platform/person/create",mdxType:"MDXCodeBlock"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-node"},'const request: TransferPlatformPersonCreateRequest = {\n originator_client_id: "6a65dh3d1h0d1027121ak184",\n name: {\
1n given_name: "Owen",\n family_name: "Gillespie"\n },\n email_address: "[email protected]",\n phone_number: "+12223334444",\n address: {\n street: "123 Main St.",\n street2: "Apt 456",\n city: "San Francisco",\n region: "CA",\n postal_code: "94580",\n country: "US"\n },\n id_number: {\n type: "us_ssn",\n value: "111223333"\n },\n date_of_birth: "2000-01-20",\n relationship_to_originator: "BENEFICIAL_OWNER",\n ownership_percentage: 50,\n title: "COO"\n};\n\ntry {\n const response = await client.transferPlatformPersonCreate(request);\n} catch (error) {\n // handle error\n}\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},'curl -X POST https://sandbox.plaid.com/transfer/platform/person/create \\\n -H \'Content-Type: application/json\' \\\n -d \'{\n "client_id": <ClientQD>"${PLAID_CLIENT_ID}"</ClientQD>,\n "secret": <SecretQD>"${PLAID_SECRET}"</SecretQD>,\n "originator_client_id": "6a65dh3d1h0d1027121ak184",\n "name": {\n "given_name": "Owen",\n "family_name": "Gillespie"\n },\n "email_address": "[email protected]",\n "phone_number": "+12223334444",\n "address": {\n "street": "123 Main St.",\n "street2": "Apt 456",\n "city": "San Francisco",\n "region": "CA",\n "postal_code": "94580",\n "country": "US"\n },\n "id_number": {\n "type": "us_ssn",\n "value": "111223333"\n },\n "date_of_birth": "2000-01-20",\n "relationship_to_originator": "BENEFICIAL_OWNER",\n "ownership_percentage": 50,\n "title": "COO"\n }\'\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'request = Plaid::TransferPlatformPersonCreateRequest.new(\n {\n originator_client_id: "6a65dh3d1h0d1027121ak184",\n name: {\n given_name: "Owen",\n family_name: "Gillespie"\n },\n email_address: "[email protected]",\n phone_number: "+12223334444",\n address: {\n street: "123 Main St.",\n street2: "Apt 456",\n city: "San Francisco",\n region: "CA",\n postal_code: "94580",\n country: "US"\n },\n id_number: {\n type: "us_ssn",\n value: "111223333"\n },\n date_of_birth: "2000-01-20",\n relationship_to_originator: "BENEFICIAL_OWNER",\n ownership_percentage: 50,\n title: "COO"\n }\n)\nresponse = client.transfer_platform_person_create(request)\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-java"},'TransferPlatformPersonCreateRequest request = new TransferPlatformPersonCreateRequest()\n .originatorClientId("6a65dh3d1h0d1027121ak184")\n .name(new TransferPlatformPersonName()\n .givenName("Owen")\n .familyName("Gillespie")\n )\n .emailAddress("[email protected]")\n .phoneNumber("+12223334444")\n .address(new TransferPlatformPersonAddress()\n .street("123 Main St.")\n .street2("Apt 456")\n .city("San Francisco")\n .region("CA")\n .postalCode("94580")\n .country("US")\n )\n .idNumber(new TransferPlatformPersonIDNumber()\n .type(IDNumberType.US_SSN)\n .value("111223333")\n )\n .dateOfBirth(LocalDate.parse("2000-01-20"))\n .relationshipToOriginator("BENEFICIAL_OWNER")\n .ownershipPercentage(50)\n .title("COO");\n\nResponse<TransferPlatformPersonCreateResponse> response = client()\n .transferPlatformPersonCreate(request)\n .execute();\n\nTransferPlatformPersonCreateResponse person =\n response.body();\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'request = TransferPlatformPersonCreateRequest(\n originator_client_id="6a65dh3d1h0d1027121ak184",\n name={\n "given_name": "Owen",\n "family_name": "Gillespie"\n },\n email_address="[email protected]",\n phone_number="+12223334444",\n address={\n "street": "123 Main St.",\n "street2": "Apt 456",\n "city": "San Francisco",\n "region": "CA",\n "postal_code": "94580",\n "country": "US"\n },\n id_number={\n "type": IDNumberType(\'us_ssn\'),\n "value": "111223333"\n },\n date_of_birth=datetime.date(2000, 1, 20),\n relationship_to_originator="BENEFICIAL_OWNER",\n ownership_percentage=50,\n title="COO"\n)\nresponse = client.transfer_platform_person_create(request)\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-go"},'request := plaid.NewTransferPlatformPersonCreateRequest(\n "6a65dh3d1h0d1027121ak184",\n)\n\nname := plaid.TransferPlatformPersonName{\n GivenName: "Owen",\n FamilyName: "G
1illespie",\n}\n\naddress := plaid.TransferPlatformPersonAddress{\n Street: "123 Main St.",\n Street2: plaid.PtrString("Apt 456"),\n City: "San Francisco",\n Region: "CA",\n PostalCode: "94580",\n Country: "US",\n}\n\nidNumber := plaid.TransferPlatformPersonIDNumber{\n Type: plaid.IDNUMBERTYPE_US_SSN,\n Value: "111223333",\n}\n\nrequest.SetName(name)\nrequest.SetEmailAddress("[email protected]")\nrequest.SetPhoneNumber("+12223334444")\nrequest.SetAddress(address)\nrequest.SetIdNumber(idNumber)\nrequest.SetDateOfBirth("2000-01-20")\nrequest.SetRelationshipToOriginator("BENEFICIAL_OWNER")\nrequest.SetOwnershipPercentage(50)\nrequest.SetTitle("COO")\n\nresponse, _, err := client.PlaidApi.TransferPlatformPersonCreate(ctx).\n TransferPlatformPersonCreateRequest(*request).\n Execute()\n')))),(0,i.kt)(p,{method:"POST",route:"/transfer/platform/person/create",type:"response",mdxType:"Schema"}),(0,i.kt)("h4",{id:"transferplatformrequirementsubmit"},"/transfer/platform/requirement/submit"),(0,i.kt)(p,{method:"POST",route:"/transfer/platform/requirement/submit",type:"request",mdxType:"Schema"},(0,i.kt)(m,{type:"server",title:"/transfer/platform/requirement/submit",mdxType:"MDXCodeBlock"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-node"},'const request: TransferPlatformRequirementSubmitRequest = {\n originator_client_id: "6a65dh3d1h0d1027121ak184",\n requirement_submissions: [\n {\n requirement_type: "BUSINESS_NAME",\n value: "Owen\'s Widgets Inc."\n },\n {\n requirement_type: "BUSINESS_EIN",\n value: "123456789"\n },\n {\n requirement_type: "BUSINESS_BANK_ACCOUNT",\n value: "{\\"access_token\\": \\"<access token>\\",\\"account_id\\": \\"<account id>\\"}"\n },\n {\n requirement_type: "BUSINESS_ORG_TYPE",\n value: "LIMITED LIABILITY COMPANY"\n },\n {\n requirement_type: "BUSINESS_INDUSTRY",\n value: "TELECOMMUNICATIONS"\n },\n {\n requirement_type: "BUSINESS_ADDRESS",\n value: "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 400\\"}"\n },\n {\n requirement_type: "BUSINESS_WEBSITE",\n value: "https://plaid.com"\n },\n {\n requirement_type: "BUSINESS_PRODUCT_DESCRIPTION",\n value: "This is a sample description."\n },\n {\n requirement_type: "ASSOCIATED_PEOPLE",\n value: "[\\"8b0e3210-767a-4882-9154-89b1e4c20493\\",\\"6ce1022c-d2c6-416d-a587-ed5e3f9bf941\\"]"\n },\n {\n requirement_type: "PERSON_NAME",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "{\\"given_name\\": \\"Jane\\",\\"family_name\\": \\"Smith\\"}"\n },\n {\n requirement_type: "PERSON_ID_NUMBER",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "{\\"type\\": \\"us_ssn\\",\\"value\\": \\"123456789\\"}"\n },\n {\n requirement_type: "PERSON_ADDRESS",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 100\\"}"\n },\n {\n requirement_type: "PERSON_DOB",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "1999-12-31"\n },\n {\n requirement_type: "PERSON_EMAIL",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "[email protected]"\n },\n {\n requirement_type: "PERSON_PHONE",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "+12345678909"\n },\n {\n requirement_type: "PERSON_RELATIONSHIP",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "BENEFICIAL_OWNER"\n },\n {\n requirement_type: "PERSON_PERCENT_OWNERSHIP",\n person_id: "8b0e3210-767a-4882-9154-89b1e4c20493",\n value: "50"\n },\n {\n requirement_type: "PERSON_TITLE",\n person_id: "8b0e3210-767a-4882-9154-89b1e4c20493",\n value: "COO"\n }\n ]\n};\n\n\ntry {\n const response = await client.transferPlatformRequirementSubmit(request);\n} catch (error) {\n // handle error\n}\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},'curl -X POST https://sandbox.plaid.com/transfer/platform/requirement/submit \\\n -H "Content-Type: application/json" \\\n -d \'{\n "client_id": <ClientQD>"${PLAID_CLIENT_ID}"</ClientQD>,\n "secret": <SecretQD>"${PLAID_SECRET}"</SecretQD>,\n "originator_client_id": "6a65dh3d1h0d1027121ak184",\n "requirement_submissions": [\n {\n "requirement_type": "BUSINESS_NAME",\n "value": "Owen\'\\\'\'s Widgets Inc."\n },\n {\n "requirement_type": "BUSINESS_EIN",\n "value": "123456789"\n },\n {\n "requirement_type": "BUSINESS_BANK_ACCOUNT",\n "value": "{\\"access_token\\"
1: \\"<access token>\\",\\"account_id\\": \\"<account id>\\"}"\n },\n {\n "requirement_type": "BUSINESS_ORG_TYPE",\n "value": "LIMITED LIABILITY COMPANY"\n },\n {\n "requirement_type": "BUSINESS_INDUSTRY",\n "value": "TELECOMMUNICATIONS"\n },\n {\n "requirement_type": "BUSINESS_ADDRESS",\n "value": "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 400\\"}"\n },\n {\n "requirement_type": "BUSINESS_WEBSITE",\n "value": "https://plaid.com"\n },\n {\n "requirement_type": "BUSINESS_PRODUCT_DESCRIPTION",\n "value": "This is a sample description."\n },\n {\n "requirement_type": "ASSOCIATED_PEOPLE",\n "value": "[\\"8b0e3210-767a-4882-9154-89b1e4c20493\\",\\"6ce1022c-d2c6-416d-a587-ed5e3f9bf941\\"]"\n },\n {\n "requirement_type": "PERSON_NAME",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "{\\"given_name\\": \\"Jane\\",\\"family_name\\": \\"Smith\\"}"\n },\n {\n "requirement_type": "PERSON_ID_NUMBER",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "{\\"type\\": \\"us_ssn\\",\\"value\\": \\"123456789\\"}"\n },\n {\n "requirement_type": "PERSON_ADDRESS",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 100\\"}"\n },\n {\n "requirement_type": "PERSON_DOB",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "1999-12-31"\n },\n {\n "requirement_type": "PERSON_EMAIL",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "[email protected]"\n },\n {\n "requirement_type": "PERSON_PHONE",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "+12345678909"\n },\n {\n "requirement_type": "PERSON_RELATIONSHIP",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "BENEFICIAL_OWNER"\n },\n {\n "requirement_type": "PERSON_PERCENT_OWNERSHIP",\n "person_id": "8b0e3210-767a-4882-9154-89b1e4c20493",\n "value": "50"\n },\n {\n "requirement_type": "PERSON_TITLE",\n "person_id": "8b0e3210-767a-4882-9154-89b1e4c20493",\n "value": "COO"\n }\n ]\n }\'\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},'request = Plaid::TransferPlatformRequirementSubmitRequest.new(\n {\n originator_client_id: "6a65dh3d1h0d1027121ak184",\n requirement_submissions: [\n {\n requirement_type: "BUSINESS_NAME",\n value: "Owen\'s Widgets Inc."\n },\n {\n requirement_type: "BUSINESS_EIN",\n value: "123456789"\n },\n {\n requirement_type: "BUSINESS_BANK_ACCOUNT",\n value: "{\\"access_token\\": \\"<access token>\\",\\"account_id\\": \\"<account id>\\"}"\n },\n {\n requirement_type: "BUSINESS_ORG_TYPE",\n value: "LIMITED LIABILITY COMPANY"\n },\n {\n requirement_type: "BUSINESS_INDUSTRY",\n value: "TELECOMMUNICATIONS"\n },\n {\n requirement_type: "BUSINESS_ADDRESS",\n value: "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 400\\"}"\n },\n {\n requirement_type: "BUSINESS_WEBSITE",\n value: "https://plaid.com"\n },\n {\n requirement_type: "BUSINESS_PRODUCT_DESCRIPTION",\n value: "This is a sample description."\n },\n {\n requirement_type: "ASSOCIATED_PEOPLE",\n value: "[\\"8b0e3210-767a-4882-9154-89b1e4c20493\\",\\"6ce1022c-d2c6-416d-a587-ed5e3f9bf941\\"]"\n },\n {\n requirement_type: "PERSON_NAME",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "{\\"given_name\\": \\"Jane\\",\\"family_name\\": \\"Smith\\"}"\n },\n {\n requirement_type: "PERSON_ID_NUMBER",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "{\\"type\\": \\"us_ssn\\",\\"value\\": \\"123456789\\"}"\n },\n {\n requirement_type: "PERSON_ADDRESS",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"regi
1on\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 100\\"}"\n },\n {\n requirement_type: "PERSON_DOB",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "1999-12-31"\n },\n {\n requirement_type: "PERSON_EMAIL",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "[email protected]"\n },\n {\n requirement_type: "PERSON_PHONE",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "+12345678909"\n },\n {\n requirement_type: "PERSON_RELATIONSHIP",\n person_id: "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n value: "BENEFICIAL_OWNER"\n },\n {\n requirement_type: "PERSON_PERCENT_OWNERSHIP",\n person_id: "8b0e3210-767a-4882-9154-89b1e4c20493",\n value: "50"\n },\n {\n requirement_type: "PERSON_TITLE",\n person_id: "8b0e3210-767a-4882-9154-89b1e4c20493",\n value: "COO"\n }\n ]\n }\n)\nresponse = client.transfer_platform_requirement_submit(request)\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-java"},'List<TransferPlatformRequirementSubmission> submissions = Arrays.asList(\n new TransferPlatformRequirementSubmission()\n .requirementType("BUSINESS_NAME")\n .value("Owen\'s Widgets Inc."),\n new TransferPlatformRequirementSubmission()\n .requirementType("BUSINESS_EIN")\n .value("123456789"),\n new TransferPlatformRequirementSubmission()\n .requirementType("BUSINESS_BANK_ACCOUNT")\n .value("{\\"access_token\\": \\"<access token>\\", \\"account_id\\": \\"<account id>\\"}"),\n new TransferPlatformRequirementSubmission()\n .requirementType("BUSINESS_ORG_TYPE")\n .value("LIMITED LIABILITY COMPANY"),\n new TransferPlatformRequirementSubmission()\n .requirementType("BUSINESS_INDUSTRY")\n .value("TELECOMMUNICATIONS"),\n new TransferPlatformRequirementSubmission()\n .requirementType("BUSINESS_ADDRESS")\n .value("{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 400\\"}"),\n new TransferPlatformRequirementSubmission()\n .requirementType("BUSINESS_WEBSITE")\n .value("https://plaid.com"),\n new TransferPlatformRequirementSubmission()\n .requirementType("BUSINESS_PRODUCT_DESCRIPTION")\n .value("This is a sample description."),\n new TransferPlatformRequirementSubmission()\n .requirementType("ASSOCIATED_PEOPLE")\n .value("[\\"8b0e3210-767a-4882-9154-89b1e4c20493\\",\\"6ce1022c-d2c6-416d-a587-ed5e3f9bf941\\"]"),\n new TransferPlatformRequirementSubmission()\n .requirementType("PERSON_NAME")\n .personId(UUID.fromString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"))\n .value("{\\"given_name\\":\\"Jane\\",\\"family_name\\":\\"Smith\\"}"),\n new TransferPlatformRequirementSubmission()\n .requirementType("PERSON_ID_NUMBER")\n .personId(UUID.fromString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"))\n .value("{\\"type\\":\\"us_ssn\\",\\"value\\":\\"123456789\\"}"),\n new TransferPlatformRequirementSubmission()\n .requirementType("PERSON_ADDRESS")\n .personId(UUID.fromString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"))\n .value("{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 100\\"}"),\n new TransferPlatformRequirementSubmission()\n .requirementType("PERSON_DOB")\n .personId(UUID.fromString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"))\n .value("1999-12-31"),\n new TransferPlatformRequirementSubmission()\n .requirementType("PERSON_EMAIL")\n .personId(UUID.fromString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"))\n .value("[email protected]"),\n new TransferPlatformRequirementSubmission()\n .requirementType("PERSON_PHONE")\n .personId(UUID.fromString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"))\n .value("+12345678909"),\n new TransferPlatformRequirementSubmission()\n .requirementType("PERSON_RELATIONSHIP")\n .personId(UUID.fromString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"))\n .value("BENEFICIAL_OWNER"),\n new TransferPlatformRequirementSubmission()\n .requirementType("PERSON_PERCENT_OWNERSHIP")\n .personId(UUID.fromString("8b0e3210-767a-4882-9154-89b1e4c20493"))\n .value("50"),\n new TransferPlatformRequirementSubmission()\n .requirementType("PERSON_TITLE")\n .personId(UUID.fromString("8b0e3210-767a-4882-9154-89b1e4c20493"))\n .value("COO")\n);\n\nTransferPlatformRequirementSubmitRequest request = new TransferPlatformRequirementSubmitRequest()\n .originatorClientId("6a65dh3d1h0d1027121ak184")\n .requirementSubmissions(submissions);\n\nResponse<TransferPlatformRequirementSubmitResponse> response =\n client.transferPlatformRequirementSubmit(request).execute();\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'request = TransferPlatformRequirementSubmitRequest(\n originator_client_id="6a65dh3d1h0d1027121ak184",\n requirement_submissions=[\n {\n "requirement_type": "BUSINESS_NAME",\n "value": "Owen\'s Widgets Inc."\n },\n {\n "requirement_type": "BUSINESS_EIN",\n "value": "123456789"\n },\n {\n "requirement_type": "BUSINESS_BANK_ACCOUNT",\n "value": "{\\"access_token\\"
1: \\"<access token>\\",\\"account_id\\": \\"<account id>\\"}"\n },\n {\n "requirement_type": "BUSINESS_ORG_TYPE",\n "value": "LIMITED LIABILITY COMPANY"\n },\n {\n "requirement_type": "BUSINESS_INDUSTRY",\n "value": "TELECOMMUNICATIONS"\n },\n {\n "requirement_type": "BUSINESS_ADDRESS",\n "value": "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 400\\"}"\n },\n {\n "requirement_type": "BUSINESS_WEBSITE",\n "value": "https://plaid.com"\n },\n {\n "requirement_type": "BUSINESS_PRODUCT_DESCRIPTION",\n "value": "This is a sample description."\n },\n {\n "requirement_type": "ASSOCIATED_PEOPLE",\n "value": "[\\"8b0e3210-767a-4882-9154-89b1e4c20493\\",\\"6ce1022c-d2c6-416d-a587-ed5e3f9bf941\\"]"\n },\n {\n "requirement_type": "PERSON_NAME",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\
1n "value": "{\\"given_name\\": \\"Jane\\",\\"family_name\\": \\"Smith\\"}"\n },\n {\n "requirement_type": "PERSON_ID_NUMBER",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "{\\"type\\": \\"us_ssn\\",\\"value\\": \\"123456789\\"}"\n },\n {\n "requirement_type": "PERSON_ADDRESS",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 100\\"}"\n },\n {\n "requirement_type": "PERSON_DOB",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "1999-12-31"\n },\n {\n "requirement_type": "PERSON_EMAIL",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "[email protected]"\n },\n {\n "requirement_type": "PERSON_PHONE",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "+12345678909"\n },\n {\n "requirement_type": "PERSON_RELATIONSHIP",\n "person_id": "6ce1022c-d2c6-416d-a587-ed5e3f9bf941",\n "value": "BENEFICIAL_OWNER"\n },\n {\n "requirement_type": "PERSON_PERCENT_OWNERSHIP",\n "person_id": "8b0e3210-767a-4882-9154-89b1e4c20493",\n "value": "50"\n },\n {\n "requirement_type": "PERSON_TITLE",\n "person_id": "8b0e3210-767a-4882-9154-89b1e4c20493",\n "value": "COO"\n }\n ]\n)\nresponse = client.transfer_platform_requirement_submit(request)\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-go"},'submissions := []plaid.TransferPlatformRequirementSubmission{\n {\n RequirementType: "BUSINESS_NAME",\n Value: "Owen\'s Widgets Inc.",\n },\n {\n RequirementType: "BUSINESS_EIN",\n Value: "123456789",\n },\n {\n RequirementType: "BUSINESS_BANK_ACCOUNT",\n Value: "{\\"access_token\\": \\"<access token>\\",\\"account_id\\": \\"<account id>\\"}",\n },\n {\n RequirementType: "BUSINESS_ORG_TYPE",\n Value: "LIMITED LIABILITY COMPANY",\n },\n {\n RequirementType: "BUSINESS_INDUSTRY",\n Value: "TELECOMMUNICATIONS",\n },\n {\n RequirementType: "BUSINESS_ADDRESS",\n Value: "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 400\\"}",\n },\n {\n RequirementType: "BUSINESS_WEBSITE",\n Value: "https://plaid.com",\n },\n {\n RequirementType: "BUSINESS_PRODUCT_DESCRIPTION",\n Value: "This is a sample description.",\n },\n {\n RequirementType: "ASSOCIATED_PEOPLE",\n Value: "[\\"8b0e3210-767a-4882-9154-89b1e4c20493\\",\\"6ce1022c-d2c6-416d-a587-ed5e3f9bf941\\"]",\n },\n {\n RequirementType: "PERSON_NAME",\n PersonId: plaid.PtrString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"),\n Value: "{\\"given_name\\": \\"Jane\\",\\"family_name\\": \\"Smith\\"}",\n },\n {\n RequirementType: "PERSON_ID_NUMBER",\n PersonId: plaid.PtrString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"),\n Value: "{\\"type\\": \\"us_ssn\\",\\"value\\": \\"123456789\\"}",\n },\n {\n RequirementType: "PERSON_ADDRESS",\n PersonId: plaid.PtrString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"),\n Value: "{\\"city\\":\\"San Francisco\\",\\"country\\":\\"US\\",\\"postal_code\\":\\"94105\\",\\"region\\":\\"CA\\",\\"street\\":\\"123 Market St\\",\\"street2\\":\\"Suite 100\\"}",\n },\n {\n RequirementType: "PERSON_DOB",\n PersonId: plaid.PtrString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"),\n Value: "1999-12-31",\n },\n {\n RequirementType: "PERSON_EMAIL",\n PersonId: plaid.PtrString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"),\n Value: "[email protected]",\n },\n {\n RequirementType: "PERSON_PHONE",\n PersonId: plaid.PtrString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"),\n Value: "+12345678909",\n },\n {\n RequirementType: "PERSON_RELATIONSHIP",\n PersonId: plaid.PtrString("6ce1022c-d2c6-416d-a587-ed5e3f9bf941"),\n Value: "BENEFICIAL_OWNER",\n },\n {\n RequirementType: "PERSON_PERCENT_OWNERSHIP",\n PersonId: plaid.PtrString("8b0e3210-767a-4882-9154-89b1e4c20493"),\n Value: "50",\n },\n {\n RequirementType: "PERSON_TITLE",\n PersonId: plaid.PtrString("8b0e3210-767a-4882-9154-89b1e4c20493"),\n Value: "COO",\n },\n}\n\nrequest := plaid.NewTransferPlatformRequirementSubmitRequest("6a65dh3d1h0d1027121ak184", submissions)\n\nresponse, _, err := client.PlaidApi.TransferPlatformRequirementSubmit(ctx).\n TransferPlatformRequirementSubmitRequest(*request).\n Execute()\n')))),(0,i.kt)(p,{method:"POST",route:"/transfer/platform/requirement/submit",type:"response",mdxType:"Schema"}),(0,i.kt)("h4",{id:"transferplatformdocumentsubmit"},"/transfer/platform/document/submit"),(0,i.kt)("p",null,"Use the ",(0,i.kt)("a",{parentName:"p",href:"#transferplatformdocumentsubmit"},(0,i.kt)("inlineCode",{parentName:"a"},"/transfer/platform/document/submit"))," endpoint to upload documents requested by Plaid to verify an originator's onboarding information. Unlike other endpoints, this one requires ",(0,i.kt)("inlineCode",{parentName:"p"},"multipart/form-data")," as the content type. This endpoint is also not included in the Plaid client libraries."),(0,i.kt)(s.Z,{schemaName:"transfer-platform-document-submit-request",route:"/transfer/platform/document/submit",entries:[["originator_client_id",{type:"string",description:"The client ID of the originator"}],["document_submission",{type:"string",description:"The path to the document file to upload"}],["requirement_type",{type:"string",description:"The type of requirement this document fulfills"}],["person_id",{type:"string",description:"The `person_id` of the person the requirement submission is related to.\n\nA `person_id` is returned by `/transfer/platform/pers
1on/create`. This field should not be included for requirements that are not related to a person.\n\nFormat: `uuid`"}]],required:["originator_client_id","document_submission","requirement_type"],expandAll:!0,isRequest:!0,type:"request",headerText:"Request fields",mdxType:"SchemaLayout"},(0,i.kt)(m,{type:"server",title:"/transfer/platform/document/submit",mdxType:"MDXCodeBlock"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-node"},"import fs from 'fs';\nimport fetch from 'node-fetch';\nimport FormData from 'form-data';\n\nconst form = new FormData();\nform.append('originator_client_id', '6a65dh3d1h0d1027121ak184');\nform.append('document_submission', fs.createReadStream('/path/to/sample/file.txt'));\nform.append('requirement_type', 'BUSINESS_ADDRESS_VALIDATION');\n\nconst res = await fetch(`https://sandbox.plaid.com/transfer/platform/document/submit`, {\n method: 'POST',\n headers: {\n 'Plaid-Client-ID': '<CLIENT_ID>',\n 'Plaid-Secret': '<SECRET>',\n ...form.getHeaders(),\n },\n body: form,\n});\nconst data = await res.json();\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},'curl -X POST https://sandbox.plaid.com/transfer/platform/document/submit \\\n -H "Content-Type: multipart/form-data" \\\n -H "Plaid-Client-ID: <CLIENT_ID>" \\\n -H "Plaid-Secret: <SECRET>" \\\n -F "originator_client_id=6a65dh3d1h0d1027121ak184" \\\n -F "document_submission=@/path/to/sample/file.txt" \\\n -F "requirement_type=BUSINESS_ADDRESS_VALIDATION"\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"require 'net/http'\nrequire 'uri'\nrequire 'openssl'\n\nuri = URI.parse(\"https://sandbox.plaid.com/transfer/platform/document/submit\")\nrequest = Net::HTTP::Post.new(uri)\nrequest[\"Plaid-Client-ID\"] = '<CLIENT_ID>'\nrequest[\"Plaid-Secret\"] = '<SECRET>'\n\nform_data = [[\n 'document_submission',\n File.open('/path/to/sample/file.txt'),\n { filename: 'file.txt', content_type: 'text/plain' }\n], ['originator_client_id', '6a65dh3d1h0d1027121ak184'], ['requirement_type', 'BUSINESS_ADDRESS_VALIDATION']]\nrequest.set_form form_data, 'multipart/form-data'\n\nreq_options = { use_ssl: uri.scheme == 'https' }\nresponse = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|\n http.request(request)\nend\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-java"},'import java.io.File;\nimport okhttp3.*;\n\nOkHttpClient client = new OkHttpClient();\n\nMediaType mediaType = MediaType.parse("text/plain");\nRequestBody fileBody = RequestBody.create(new File("/path/to/sample/file.txt"), mediaType);\n\nMultipartBody requestBody = new MultipartBody.Builder()\n .setType(MultipartBody.FORM)\n .addFormDataPart("originator_client_id", "6a65dh3d1h0d1027121ak184")\n .addFormDataPart("requirement_type", "BUSINESS_ADDRESS_VALIDATION")\n .addFormDataPart("document_submission", "file.txt", fileBody)\n .build();\n\nRequest request = new Request.Builder()\n .url("https://sandbox.plaid.com/transfer/platform/document/submit")\n .addHeader("Plaid-Client-ID", "<CLIENT_ID>")\n .addHeader("Plaid-Secret", "<SECRET>")\n .post(requestBody)\n .build();\n\nResponse response = client.newCall(request).execute();\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},"import requests\n\nurl = \"https://sandbox.plaid.com/transfer/platform/document/submit\"\nheaders = {\n 'Plaid-Client-ID': '<CLIENT_ID>',\n 'Plaid-Secret': '<SECRET>'\n}\ndata = {\n 'originator_client_id': '6a65dh3d1h0d1027121ak184',\n 'requirement_type': 'BUSINESS_ADDRESS_VALIDATION'\n}\nfiles = {\n 'document_submission': ('file.txt', open('/path/to/sample/file.txt', 'rb'), 'text/plain')\n}\n\nresponse = requests.post(url, headers=headers, data=data, files=files)\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-go"},'package main\n\nimport (\n "bytes"\n "io"\n "mime/multipart"\n "net/http"\n "os"\n)\n\nfunc main() {\n var buf bytes.Buffer\n writer := multipart.NewWriter(&buf)\n\n writer.WriteField("originator_client_id", "6a65dh3d1h0d1027121ak184")\n writer.WriteField("requirement_type", "BUSINESS_ADDRESS_VALIDATION")\n\n file, _ := os.Open("/path/to/sample/file.txt")\n defer file.Close()\n part, _ := writer.CreateFormFile("document_submission", "file.txt")\n io.Copy(part, file)\n writer.Close()\n\n req, _ := http.NewRequest("POST", "https://sandbox.plaid.com/transfer/platform/document/submit", &buf)\n req.Header.Set("Content-Type", writer.FormDataContentType())\n req.Header.Set("Plaid-Client-ID", "<CLIENT_ID>")\n req.Header.Set("Plaid-Secret", "<SECRET>")\n\n http.DefaultClient.Do(req)\n}\n')))),(0,i.kt)(s.Z,{schemaName:"transfer-platform-document-submit-response",route:"/transfer/platform/document/submit",entries:[["request_id",{type:"string",description:"A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."}]],type:"response",headerText:"Response fields",tableOnly:!1,mdxType:"SchemaLayout"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json",metastring:"#Sample response","#Sample":!0,response:!0},'{\n "request_id": "YkP5Aq2x9LkZQb7"\n}\n'))),(0,i.kt)("h4",{id:"transferoriginatorget"},"/transfer/originator/get"),(0,i.kt)(p,{method:"POST",route:"/transfer/originator/get",type:"request",mdxType:"Schema"},(0,i.kt)(m,{type:"server",title:"/transfer/originator/get",mdxType:"MDXCodeBlock"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-node"},"const request: TransferOriginatorGetRequest = {\n originator_client_id: '6a65dh3d1h0d1027121ak184',\n};\n\ntry {\n const response = await client.transferOriginatorGet(request);\n} catch (error) {\n // handle error\n}\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},'curl -X POST https://sandbox.plaid.com/transfer/originator/get \\\n -H \'Content-Type: application/json\' \\\n -d \'{\n "client_id": <ClientQD>"${PLAID_CLIENT_ID}"</ClientQD>,\n "secret": <SecretQD>"${PLAID_SECRET}"</SecretQD>,\n "originator_client_id": "6a65dh3d1h0d1027121ak184"\n }\'\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"request = Plaid::TransferOriginatorGetRequest.new(\n {\n originator_client_id: '6a65dh3d1h0d1027121ak184',\n }\n)\nresponse = client.transfer_originator_get(request)\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-java"},'TransferOriginatorGetRequest request = new TransferOriginatorGetRequest
1()\n .originatorClientId("6a65dh3d1h0d1027121ak184");\n\nResponse<TransferOriginatorGetResponse> response = client()\n .transferOriginatorGet(request)\n .execute();\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},"request = TransferOriginatorGetRequest(\n originator_client_id='6a65dh3d1h0d1027121ak184',\n)\nresponse = client.transfer_originator_get(request)\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-go"},'request := plaid.NewTransferOriginatorGetRequest(\n "6a65dh3d1h0d1027121ak184",\n)\n\nresponse, _, err := client.PlaidApi.TransferOriginatorGet(ctx).TransferOriginatorGetRequest(*request).Execute()\n')))),(0,i.kt)(p,{method:"POST",route:"/transfer/originator/get",type:"response",mdxType:"Schema"}),(0,i.kt)("h4",{id:"transferoriginatorlist"},"/transfer/originator/list"),(0,i.kt)(p,{method:"POST",route:"/transfer/originator/list",type:"request",mdxType:"Schema"},(0,i.kt)(m,{type:"server",title:"/transfer/originator/list",mdxType:"MDXCodeBlock"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-node"},"const request: TransferOriginatorListRequest = {\n count: 14,\n offset: 2,\n};\n\ntry {\n const response = await client.transferOriginatorList(request);\n} catch (error) {\n // handle error\n}\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},'curl -X POST https://sandbox.plaid.com/transfer/originator/list \\\n -H \'Content-Type: application/json\' \\\n -d \'{\n "client_id": <ClientQD>"${PLAID_CLIENT_ID}"</ClientQD>,\n "secret": <SecretQD>"${PLAID_SECRET}"</SecretQD>,\n "count": 14,\n "offset": 2\n }\'\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"request = Plaid::TransferOriginatorListRequest.new(\n {\n count: 14,\n offset: 2,\n }\n)\nresponse = client.transfer_originator_list(request)\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-java"},"TransferOriginatorListRequest request = new TransferOriginatorListRequest()\n .count(14)\n .offset(2);\n\nResponse<TransferOriginatorListResponse> response = client()\n .transferOriginatorList(request)\n .execute();\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},"request = TransferOriginatorListRequest(\n count=14,\n offset=2,\n)\nresponse = client.transfer_originator_list(request)\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-go"},"request := plaid.NewTransferOriginatorListRequest()\nrequest.SetCount(14)\nrequest.SetOffset(2)\n\nresponse, _, err := client.PlaidApi.TransferOriginatorList(ctx).TransferOriginatorListRequest(*request).Execute()\n")))),(0,i.kt)(p,{method:"POST",route:"/transfer/originator/list",type:"response",mdxType:"Schema"}),(0,i.kt)("h4",{id:"transferoriginatorfunding_accountcreate"},"/transfer/originator/funding_account/create"),(0,i.kt)(p,{method:"POST",route:"/transfer/originator/funding_account/create",type:"request",mdxType:"Schema"},(0,i.kt)(m,{type:"server",title:"/transfer/originator/funding_account/create",mdxType:"MDXCodeBlock"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-node"},"const request: TransferOriginatorFundingAccountCreateRequest = {\n originator_client_id: '6a65dh3d1h0d1027121ak184',\n funding_account: {\n access_token: 'access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',\n account_id: '3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr',\n },\n};\n\ntry {\n const response = await client.transferOriginatorFundingAccountCreate(request);\n} catch (error) {\n // handle error\n}\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},'curl -X POST https://sandbox.plaid.com/transfer/originator/funding_account/create \\\n -H \'Content-Type: application/json\' \\\n -d \'{\n "client_id": <ClientQD>"${PLAID_CLIENT_ID}"</ClientQD>,\n "secret": <SecretQD>"${PLAID_SECRET}"</SecretQD>,\n "originator_client_id": "6a65dh3d1h0d1027121ak184",\n "funding_account": {\n "access_token": "access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175",\n "account_id": "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr"\n }\n }\'\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-ruby"},"request = Plaid::TransferOriginatorFundingAccountCreateRequest.new(\n {\n originator_client_id: '6a65dh3d1h0d1027121ak184',\n funding_account: {\
1n access_token: 'access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175',\n account_id: '3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr',\n },\n }\n)\nresponse = client.transfer_originator_funding_account_create(request)\n")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-java"},'TransferFundingAccountWithDisplayName fundingAccount = new TransferFundingAccountWithDisplayName()\n .accessToken("access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175")\n .accountId("3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr");\nTransferOriginatorFundingAccountCreateRequest request = new TransferOriginatorFundingAccountCreateRequest()\n .originatorClientId("6a65dh3d1h0d1027121ak184")\n .fundingAccount(fundingAccount);\n\nResponse<TransferOriginatorFundingAccountCreateResponse> response = client()\n .transferOriginatorFundingAccountCreate(request)\n .execute();\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-python"},'request = TransferOriginatorFundingAccountCreateRequest(\n originator_client_id="6a65dh3d1h0d1027121ak184",\n funding_account=TransferFundingAccountWithDisplayName(\n access_token="access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175",\n account_id="3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",\n ),\n)\nresponse = client.transfer_originator_funding_account_create(request)\n')),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-go"},'request := plaid.NewTransferOriginatorFundingAccountCreateRequest(\n "6a65dh3d1h0d1027121ak184",\n *plaid.NewTransferFundingAccountWithDisplayName(\n "access-sandbox-71e02f71-0960-4a27-abd2-5631e04f2175",\n "3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr",\n ),\n)\n\nresponse, _, err := client.PlaidApi.TransferOriginatorFundingAccountCreate(ctx).TransferOriginatorFundingAccountCreateRequest(*request).Execute()\n')))),(0,i.kt)(p,{method:"POST",route:"/transfer/originator/funding_account/create",type:"response",mdxType:"Schema"}),(0,i.kt)("h3",{id:"webhooks"},"Webhooks"),(0,i.kt)("h4",{id:"platform_onboarding_update"},(0,i.kt)("inlineCode",{parentName:"h4"},"PLATFORM_ONBOARDING_UPDATE")),(0,i.kt)(p,{model:"TransferPlatformOnboardingUpdateWebhook",type:"model",mdxType:"Schema"}))}_.isMDXComponent=!0;var S=[{id:"transferplatformoriginatorcreate",level:4,title:"/transfer/platform/originator/create"},{id:"transferplatformpersoncreate",level:4,title:"/transfer/platform/person/create"},{id:"transferplatformrequirementsubmit",level:4,title:"/transfer/platform/requirement/submit"},{id:"transferplatformdocumentsubmit",level:4,title:"/transfer/platform/document/submit"},{id:"transferoriginatorget",level:4,title:"/transfer/originator/get"},{id:"transferoriginatorlist",level:4,title:"/transfer/originator/list"},{id:"transferoriginatorfunding_accountcreate",level:4,title:"/transfer/originator/funding_account/create"},{id:"webhooks",level:3,title:"Webhooks"},{id:"platform_onboarding_update",level:4,title:"PLATFORM_ONBOARDING_UPDATE"}];f.tableOfContents=S,_.layoutProps=f,_.layout=function(e){return(0,i.kt)(o.Z,e)}},12107:function(e,n,t){(window.__NEXT_P=window.__NEXT_P||[]).push(["/docs/api/products/transfer/platform-payments",function(){return t(3062)}])}},function(e){e.O(0,[49774,86898,26736,29622,12291,22359,68239,79255,92888,40179],function(){return e(e.s=12107)}),_N_E=e.O()}]); 2//# sourceMappingURL=platform-payments-94a9696f0d6e7b7d.js.map
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.