{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v3/accounts/:accountId/:fieldId","auth":"required","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\" : \"AC-U4BWHGZDG6W\",\n  \"status\" : \"PENDING\",\n  \"type\" : \"INDIVIDUAL\",\n  \"country\" : \"US\",\n  \"createdAt\" : 1541789972000,\n  \"depositAddresses\" : {\n    \"ETH\" : \"0x98B031783d0efb1E65C4072C6576BaCa0736A912\",\n    \"BTC\" : \"14CriXWTRoJmQdBzdikw6tEmSuwxMozWWq\"\n  },\n  \"totalBalances\" : { \n    \"BTC\" : 1.0000000,\n    \"ETH\" : 0.1000000000000000000\n  },\n  \"availableBalances\" : { \n    \"BTC\" : 1.0000000,\n    \"ETH\" : 0.1000000000000000000\n  },\n  \"profileData\" : [ {\n    \"fieldId\" : \"individualCellphoneNumber\",\n    \"fieldType\" : \"CELLPHONE\",\n    \"value\" : null,\n    \"note\" : \"Must be verified by user.\",\n    \"status\" : \"OPEN\"\n  }, {\n    \"fieldId\" : \"individualEmail\",\n    \"fieldType\" : \"EMAIL\",\n    \"value\" : \"johnnyquest22:::at:::yolo.com\",\n    \"note\" : \"Must be verified by user.\",\n    \"status\" : \"OPEN\"\n  }, {\n    \"fieldId\" : \"individualLegalName\",\n    \"fieldType\" : \"STRING\",\n    \"value\" : \"Johnny Quest\",\n    \"note\" : null,\n    \"status\" : \"PENDING\"\n  }, {\n    \"fieldId\" : \"individualDateOfBirth\",\n    \"fieldType\" : \"DATE\",\n    \"value\" : null,\n    \"note\" : null,\n    \"status\" : \"OPEN\"\n  }, {\n    \"fieldId\" : \"individualSsn\",\n    \"fieldType\" : \"STRING\",\n    \"value\" : null,\n    \"note\" : null,\n    \"status\" : \"NULL\"\n  }, {\n    \"fieldId\" : \"individualResidenceAddress\",\n    \"fieldType\" : \"ADDRESS\",\n    \"value\" : {\n        \"street1\": \"1 Market St\",\n        \"street2\": \"Suite 402\",\n        \"city\": \"San Francisco\",\n        \"state\": \"CA\",\n        \"postalCode\": \"94105\",\n        \"country\": \"US\"\n    },\n    \"note\" : null,\n    \"status\" : \"PENDING\"\n  }, {\n    \"fieldId\" : \"individualGovernmentId\",\n    \"fieldType\" : \"DOCUMENT\",\n    \"value\" : [\"D2HLR7QCNZH\"],\n    \"note\" : null,\n    \"status\" : \"PENDING\"\n  }, {\n    \"fieldId\" : \"individualSourceOfFunds\",\n    \"fieldType\" : \"PAYMENT_METHOD\",\n    \"value\" : null,\n    \"note\" : \"Payment method not yet submitted\",\n    \"status\" : \"OPEN\"\n  } ]\n}","name":""}]},"examples":{"codes":[{"language":"curl","code":"\tcurl -X POST \\\n  \t'http://api.sendwyre.com/v3/accounts/AC-DM4ANREWUNJ/individualGovernmentId?documentType=DRIVING_LICENSE&documentSubType=FRONT&timestamp=1426252182534' \\\n    --upload-file '/Users/user/passport.pdf' \\\n  \t-H 'Content-Type: application/pdf' \\\n  \t-H 'Authorization: Bearer SK-XXX-XXX-XXX' \\\n\n\tcurl -X POST \\\n  \t'http://api.sendwyre.com/v3/accounts/AC-DM4ANREWUNJ/individualGovernmentId?documentType=DRIVING_LICENSE&documentSubType=BACK&timestamp=1426252182534' \\\n    --upload-file '/Users/user/passport.pdf' \\\n  \t-H 'Content-Type: application/pdf' \\\n  \t-H 'Authorization: Bearer SK-XXX-XXX-XXX' \\"},{"code":"<!-- Use in conjusction with upload.js on the next tab -->\n<!doctype html>\n\n<html lang=\"en\">\n<head>\n  <meta charset=\"utf-8\">\n\n  <title>Wyre Document Upload</title>\n\n</head>\n\n<body>\n    <input type=\"file\">\n    <script src=\"./upload.js\"></script>\n</body>\n</html>","language":"html","name":"index.html"},{"code":"// Upload js file used in conjunction with index.html in the previous tab\nconst input = document.querySelector('input');\n\nlet uploadToWyre = (data) =>{\n    let timestamp = Date.now();\n    let headers = {};\n    headers['Authorization'] = 'Bearer SK-XXXXXX-XXXXXX-XXXXXX-XXXXXX';\n    headers['Content-Type'] = 'image/png';\n    fetch(`https://api.testwyre.com/v3/accounts/AC_XXXXXXXXXX/individualGovernmentId?documentType=PASSPORT&timestamp=${timestamp}`, {\n        method: \"POST\",\n        headers:  headers,\n        body: data.target.files[0]\n        }).then(res => {\n        console.log(\"Request complete! response:\", res);\n    });\n}\n\ninput.addEventListener('input', uploadToWyre);","language":"javascript","name":"upload.js"}]},"method":"post","params":[{"name":"accountId","type":"string","default":"the ID of the Account that the document belongs to","desc":"","required":true,"in":"path","ref":"","_id":"5be606f1a48cd4005cf889c4"},{"name":"fieldId","type":"string","default":"","desc":"fieldId that the uploaded document is associated with. See list of valid fieldId values [here](/docs/account-resource#section-field-ids). Only fieldId values of type `DOCUMENT` will accept a document upload.","required":true,"in":"path","ref":"","_id":"5be6074278138b001d9dcf3d"},{"name":"documentType","type":"string","default":"GOVT_ID","desc":"For individualGovernmentId fieldId, you could specify the documentType. Possible values are GOVT_ID, DRIVING_LICENSE, PASSPORT_CARD and PASSPORT","required":false,"in":"query","ref":"","_id":"5f2b26edba1dd30065b3e5fc"},{"name":"documentSubType","type":"string","default":"","desc":"For individualGovernmentId fieldId, you could specify the documentSubType. Possible values are FRONT and BACK. For individualGovernmentId fieldId, it is required to upload both FRONT and BACK for GOVT_ID, DRIVING_LICENSE and PASSPORT_CARD.","required":false,"in":"query","ref":"","_id":"5f2b26edba1dd30065b3e5fb"}],"apiSetting":"5c50b085aae6150014b3e80e"},"next":{"description":"","pages":[]},"title":"Upload Document","type":"endpoint","slug":"upload-document","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Supported FieldIds\",\n  \"body\": \"Note: Only `individualProofOfAddress`,`individualGovernmentId`, and `individualAchAuthorizationForm` fieldIds are accepted through this endpoint. Please see [Account Overview](/docs/account-resource#section-field-ids) for more information.\\n\\n`individualAchAuthorizationForm` is used to verify a payment method after our compliance team has requested further verification.\"\n}\n[/block]\n## Supported Document Types\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Document Type\",\n    \"h-1\": \"Content-Type(s)\",\n    \"0-1\": \"`application/pdf`\",\n    \"1-1\": \"`image/jpeg`\\n`image/png`\",\n    \"2-1\": \"`application/msword`\\n`application/vnd.openxmlformats-officedocument.wordprocessingml.document`\",\n    \"1-0\": \"Images\",\n    \"0-0\": \"PDF\",\n    \"2-0\": \"Word Document (.doc or .docx)\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Max Filesize\",\n  \"body\": \"Maximum file upload size is 7.75MB\"\n}\n[/block]","updates":["5c19a2f6a856f200e7aefbae","5f1b5d100c001200128cc5c3"],"order":5,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5be606f1a48cd4005cf889c3","project":"550f74bb6fc8130d0038aad3","version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded","5e8127d61c906800374eeb1c","5f2768c98622b8005106544a","5f2768d05702ca0011f7655e","5f276e5348d2b600321aef9b","5f276fd300e519001139200a","5f9a2cb79dafe500259281a7","5fd92bf362bb7301b00e48ba"],"_id":"550f75de61d9d30d00af9e01","__v":24,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Accounts","slug":"accounts","order":9,"from_sync":false,"reference":true,"_id":"5bc633a722d682005c9ad9e4","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","createdAt":"2018-10-16T18:53:27.204Z","__v":0},"user":"56ddd4424acab82000ae9d30","createdAt":"2018-11-09T22:15:13.738Z","__v":29,"parentDoc":null}

Wyre API

Cookbooks

Key Management

Wyre Checkout

Card Processing

Wallets

Savings (beta)

Transfers & Exchanges

Accounts

Payment Methods

Global Payouts

Data Subscriptions

postUpload Document

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

accountId:
required
stringthe ID of the Account that the document belongs to
fieldId:
required
string
fieldId that the uploaded document is associated with. See list of valid fieldId values [here](/docs/account-resource#section-field-ids). Only fieldId values of type `DOCUMENT` will accept a document upload.

Query Params

documentType:
stringGOVT_ID
For individualGovernmentId fieldId, you could specify the documentType. Possible values are GOVT_ID, DRIVING_LICENSE, PASSPORT_CARD and PASSPORT
documentSubType:
string
For individualGovernmentId fieldId, you could specify the documentSubType. Possible values are FRONT and BACK. For individualGovernmentId fieldId, it is required to upload both FRONT and BACK for GOVT_ID, DRIVING_LICENSE and PASSPORT_CARD.

Examples

Result Format

Documentation

[block:callout] { "type": "info", "title": "Supported FieldIds", "body": "Note: Only `individualProofOfAddress`,`individualGovernmentId`, and `individualAchAuthorizationForm` fieldIds are accepted through this endpoint. Please see [Account Overview](/docs/account-resource#section-field-ids) for more information.\n\n`individualAchAuthorizationForm` is used to verify a payment method after our compliance team has requested further verification." } [/block] ## Supported Document Types [block:parameters] { "data": { "h-0": "Document Type", "h-1": "Content-Type(s)", "0-1": "`application/pdf`", "1-1": "`image/jpeg`\n`image/png`", "2-1": "`application/msword`\n`application/vnd.openxmlformats-officedocument.wordprocessingml.document`", "1-0": "Images", "0-0": "PDF", "2-0": "Word Document (.doc or .docx)" }, "cols": 2, "rows": 3 } [/block] [block:callout] { "type": "info", "title": "Max Filesize", "body": "Maximum file upload size is 7.75MB" } [/block]