Upload Document

Your user might be required to further authenticate their identity by providing a document such as a valid driver's license, passport, bank statement, or utility bill.

The maximum file size is 7.75MB

Note: Only individualProofOfAddress and individualGovernmentId fieldIds are accepted through this endpoint. Please see Account Overview for more information.

Supported Document Types

Document Type

Content-Type(s)

PDF

application/pdf

Images

image/jpeg image/png

Word Document (.doc or .docx)

application/msword application/vnd.openxmlformats-officedocument.wordprocessingml.document

Upload Document

POST https://api.sendwyre.com/v3/accounts/:accountId/:fieldId

Path Parameters

Name
Type
Description

accountId

string

the ID of the Account that the document belongs to

fieldId

string

fieldId that the uploaded document is associated with. See list of valid fieldId values here. Only fieldId values of type DOCUMENT will accept a document upload.

{
  "id" : "AC-U4BWHGZDG6W",
  "status" : "PENDING",
  "type" : "INDIVIDUAL",
  "country" : "US",
  "createdAt" : 1541789972000,
  "depositAddresses" : {
    "ETH" : "0x98B031783d0efb1E65C4072C6576BaCa0736A912",
    "BTC" : "14CriXWTRoJmQdBzdikw6tEmSuwxMozWWq"
  },
  "totalBalances" : { 
    "BTC" : 1.0000000,
    "ETH" : 0.1000000000000000000
  },
  "availableBalances" : { 
    "BTC" : 1.0000000,
    "ETH" : 0.1000000000000000000
  },
  "profileData" : [ {
    "fieldId" : "individualCellphoneNumber",
    "fieldType" : "CELLPHONE",
    "value" : null,
    "note" : "Must be verified by user.",
    "status" : "OPEN"
  }, {
    "fieldId" : "individualEmail",
    "fieldType" : "EMAIL",
    "value" : "johnnyquest22@yolo.com",
    "note" : "Must be verified by user.",
    "status" : "OPEN"
  }, {
    "fieldId" : "individualLegalName",
    "fieldType" : "STRING",
    "value" : "Johnny Quest",
    "note" : null,
    "status" : "PENDING"
  }, {
    "fieldId" : "individualDateOfBirth",
    "fieldType" : "DATE",
    "value" : null,
    "note" : null,
    "status" : "OPEN"
  }, {
    "fieldId" : "individualSsn",
    "fieldType" : "STRING",
    "value" : null,
    "note" : null,
    "status" : "NULL"
  }, {
    "fieldId" : "individualResidenceAddress",
    "fieldType" : "ADDRESS",
    "value" : {
        "street1": "1 Market St",
        "street2": "Suite 402",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
    },
    "note" : null,
    "status" : "PENDING"
  }, {
    "fieldId" : "individualGovernmentId",
    "fieldType" : "DOCUMENT",
    "value" : ["D2HLR7QCNZH"],
    "note" : null,
    "status" : "PENDING"
  }, {
    "fieldId" : "individualSourceOfFunds",
    "fieldType" : "PAYMENT_METHOD",
    "value" : null,
    "note" : "Payment method not yet submitted",
    "status" : "OPEN"
  } ]
}

Examples

curl -X POST \
    'http://api.sendwyre.com/v3/accounts/AC-DM4ANREWUNJ/individualGovernmentId?timestamp=1426252182534' \
    --upload-file '/Users/user/passport.pdf' \
    -H 'Content-Type: application/pdf' \
    -H 'X-Api-Signature: XXXX' \
    -H 'X-Api-Key: XXXX'

Last updated

Was this helpful?