{"_id":"5be606f1a48cd4005cf889c3","project":"550f74bb6fc8130d0038aad3","version":{"_id":"550f75de61d9d30d00af9e01","__v":17,"project":"550f74bb6fc8130d0038aad3","forked_from":"550f74bb6fc8130d0038aad6","createdAt":"2015-03-23T02:09:34.221Z","releaseDate":"2015-03-23T02:09:34.221Z","categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5bc633a722d682005c9ad9e4","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2018-10-16T18:53:27.204Z","from_sync":false,"order":6,"slug":"accounts","title":"Accounts"},"user":"56ddd4424acab82000ae9d30","__v":12,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":["5c19a2f6a856f200e7aefbae"],"next":{"pages":[],"description":""},"createdAt":"2018-11-09T22:15:13.738Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","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}","language":"json","status":200}]},"examples":{"codes":[{"code":"\tcurl -X POST \\\n  \t'http://api.sendwyre.com/v3/accounts/AC-DM4ANREWUNJ/individualGovernmentId?timestamp=1426252182534' \\\n    --upload-file '/Users/user/passport.pdf' \\\n  \t-H 'Content-Type: application/pdf' \\\n  \t-H 'X-Api-Signature: XXXX' \\\n    -H 'X-Api-Key: XXXX'\n","language":"curl"}]},"method":"post","apiSetting":"5c50b085aae6150014b3e80e","auth":"required","params":[{"_id":"5be606f1a48cd4005cf889c4","ref":"","in":"path","required":true,"desc":"","default":"the ID of the Account that the document belongs to","type":"string","name":"accountId"},{"_id":"5be6074278138b001d9dcf3d","ref":"","in":"path","required":true,"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.","default":"","type":"string","name":"fieldId"}],"url":"/v3/accounts/:accountId/:fieldId"},"isReference":true,"order":6,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Supported FieldIds\",\n  \"body\": \"Note: Only `individualProofOfAddress` and `individualGovernmentId` fieldIds are accepted through this endpoint. Please see [Account Overview](/docs/account-resource#section-field-ids) for more information.\"\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]","excerpt":"","slug":"upload-document","type":"endpoint","title":"Upload Document"}

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.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Supported FieldIds", "body": "Note: Only `individualProofOfAddress` and `individualGovernmentId` fieldIds are accepted through this endpoint. Please see [Account Overview](/docs/account-resource#section-field-ids) for more information." } [/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]