{"_id":"5be5cf2d8c10ea0050e0640a","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":"54eb883f4f94620d00789aaa","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-11-09T18:17:17.065Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","apiSetting":null,"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"This represents the present state of an identifiable, KYC'able entity; either an [individual or a business](#section-account-types) based in a specific country for transacting with Wyre. \n\nIt contains a collection of profile *Fields*, each holding a single datapoint and [field verification status](#section-field-statuses). Fields may be approved or rejected individually.\n\nThis collection of fields contribute to the overall [account verification status](#section-account-status). Once all fields have been approved, the account will transition to approved and become eligible for transacting.\n\nBeyond KYC, each account may maintain a ledger balance with Wyre. Deposit addresses are provided for depositing into these ledger balances.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"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\\t\\t\\t\\t\\\"street1\\\": \\\"1 Market St\\\",\\n\\t\\t\\t\\t\\\"street2\\\": \\\"Suite 402\\\",\\n\\t\\t\\t\\t\\\"city\\\": \\\"San Francisco\\\",\\n\\t\\t\\t\\t\\\"state\\\": \\\"CA\\\",\\n\\t\\t\\t\\t\\\"postalCode\\\": \\\"94105\\\",\\n\\t\\t\\t\\t\\\"country\\\": \\\"US\\\"\\n\\t\\t},\\n    \\\"note\\\" : null,\\n    \\\"status\\\" : \\\"PENDING\\\"\\n  }, {\\n    \\\"fieldId\\\" : \\\"individualGovernmentId\\\",\\n    \\\"fieldType\\\" : \\\"DOCUMENT\\\",\\n    \\\"value\\\" : [],\\n    \\\"note\\\" : null,\\n    \\\"status\\\" : \\\"OPEN\\\"\\n  }, {\\n    \\\"fieldId\\\" : \\\"individualSourceOfFunds\\\",\\n    \\\"fieldType\\\" : \\\"PAYMENT_METHOD\\\",\\n    \\\"value\\\" : null,\\n    \\\"note\\\" : \\\"Payment method not yet submitted\\\",\\n    \\\"status\\\" : \\\"OPEN\\\"\\n  } ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Account Status\n\nAccounts can have one of 4 statuses:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`OPEN`\",\n    \"1-0\": \"`PENDING`\",\n    \"2-0\": \"`APPROVED`\",\n    \"3-0\": \"`CLOSED`\",\n    \"h-0\": \"Status\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"Waiting on action from you or the Account holder. \\n\\nThis is the initial state before all information has been submitted, or after any has failed to pass verifications.\",\n    \"1-1\": \"Information has been fully submitted and is waiting on review from Wyre. The Account cannot yet transact.\",\n    \"2-1\": \"Information has been reviewed and accepted by Wyre. The Account is now approved to transact.\",\n    \"3-1\": \"The Account has been closed and may not transact\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## Account Types\n\nAccounts can be of two different Types:\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note\",\n  \"body\": \"Currently only `INDIVIDUAL` accounts are supported through our API.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`INDIVIDUAL`\",\n    \"1-0\": \"`BUSINESS`\",\n    \"0-1\": \"Used to register a personal account.\",\n    \"1-1\": \"*Used to register a business entity account.*\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Fields\"\n}\n[/block]\nProfile *Fields* are objects that each represent one KYC data point we collect on the Account, along with its present verification status. A Field has the following properties:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`fieldId`\",\n    \"1-0\": \"`fieldType`\",\n    \"2-0\": \"`value`\",\n    \"3-0\": \"`note`\",\n    \"4-0\": \"`status`\",\n    \"h-0\": \"Field Parameter\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The specific datapoint encapsulated by the Field. [See field IDs](#section-field-ids).\",\n    \"1-1\": \"Defines the format and/or structure of the `value` parameter. [See types](#section-field-types)\",\n    \"2-1\": \"A representation of the underlying KYC data. Actual format depends on `fieldType`\",\n    \"4-1\": \"The current verification status of the field. [See statuses](#section-field-statuses)\",\n    \"3-1\": \"A message to the accountholder regarding the field\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\nWhen the Account is created the `profileFields` array is automatically populated with all of the Fields that must be submitted in order for the Account to be approved and be able to transact.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"fieldId\\\" : \\\"individualResidenceAddress\\\",\\n    \\\"fieldType\\\" : \\\"ADDRESS\\\",\\n    \\\"value\\\" : {\\n\\t\\t\\t\\t\\\"street1\\\": \\\"1 Market St\\\",\\n\\t\\t\\t\\t\\\"street2\\\": \\\"Suite 402\\\",\\n\\t\\t\\t\\t\\\"city\\\": \\\"San Francisco\\\",\\n\\t\\t\\t\\t\\\"state\\\": \\\"CA\\\",\\n\\t\\t\\t\\t\\\"postalCode\\\": \\\"94105\\\",\\n\\t\\t\\t\\t\\\"country\\\": \\\"US\\\"\\n\\t\\t},\\n    \\\"note\\\" : null,\\n    \\\"status\\\" : \\\"PENDING\\\"\\n  }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Field Statuses\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Status\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`OPEN`\",\n    \"1-0\": \"`PENDING`\",\n    \"2-0\": \"`APPROVED`\",\n    \"0-1\": \"Waiting on action from you or the Account holder. \\n\\nThis is the initial state before any information has been submitted, or after it has failed to pass verifications.\",\n    \"1-1\": \"Information has been fully submitted and is waiting on review from Wyre.\",\n    \"2-1\": \"Information has been reviewed and accepted by Wyre.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## Field IDs\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"fieldId Value\",\n    \"h-1\": \"Field Type\",\n    \"0-0\": \"`individualLegalName`\",\n    \"1-0\": \"`individualCellphoneNumber`\",\n    \"2-0\": \"`individualEmail`\",\n    \"3-0\": \"`individualResidenceAddress`\",\n    \"4-0\": \"`individualGovernmentId`\",\n    \"5-0\": \"`individualDateOfBirth`\",\n    \"6-0\": \"`individualSsn`\",\n    \"7-0\": \"`individualSourceOfFunds`\",\n    \"0-1\": \"**STRING**\",\n    \"1-1\": \"**CELLPHONE**\",\n    \"2-1\": \"**EMAIL**\",\n    \"3-1\": \"**ADDRESS**\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The full legal name of the account holder\",\n    \"1-2\": \"the cellphone number of the account holder\",\n    \"2-2\": \"the email address of the account holder\",\n    \"3-2\": \"the residence address of the account holder\",\n    \"4-1\": \"**DOCUMENT**\",\n    \"5-1\": \"**DATE**\",\n    \"6-1\": \"**STRING**\",\n    \"7-1\": \"**PAYMENT_METHOD**\",\n    \"4-2\": \"a scan or photo of a drivers license or passport of the account holder\",\n    \"5-2\": \"the account holder's date of birth\",\n    \"6-2\": \"the account holder's social security number\",\n    \"7-2\": \"a payment method that the account holder owns.\",\n    \"8-0\": \"`individualProofOfAddress`\",\n    \"8-1\": \"**DOCUMENT**\",\n    \"8-2\": \"a utility bill or bank statement. `individualProofOfAddress` will start in the `PENDING` state as we will attempt to use the `individualSourceOfFunds` to fill this requirement. If we aren’t able to verify the address from the user’s bank account we will mark the `individualProofOfAddress` field as `OPEN`. When this field is `OPEN`, the user should be displayed the note on the field and prompted to upload a document\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Currently only INDIVIDUAL accounts are supported through our API.\",\n  \"title\": \"Note\"\n}\n[/block]\n## Field Types\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"fieldType value\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`STRING`\",\n    \"1-0\": \"`CELLPHONE`\",\n    \"2-0\": \"`EMAIL`\",\n    \"3-0\": \"`ADDRESS`\",\n    \"4-0\": \"`DATE`\",\n    \"5-0\": \"`DOCUMENT`\",\n    \"6-0\": \"`PAYMENT_METHOD`\",\n    \"1-1\": \"A full cellphone number including country code\\n\\ne.g. `+15554445555`\",\n    \"2-1\": \"A correctly formatted email address\",\n    \"3-1\": \"An address object. Address format is:\\n\\n```json\\n{\\n\\t\\\"street1\\\": \\\"1 Market St\\\",\\n\\t\\\"street2\\\": \\\"Suite 402\\\",\\n\\t\\\"city\\\": \\\"San Francisco\\\",\\n\\t\\\"state\\\": \\\"CA\\\",\\n\\t\\\"postalCode\\\": \\\"94105\\\",\\n\\t\\\"country\\\": \\\"US\\\"\\n}\\n```\",\n    \"4-1\": \"Specifies a particular day. Format is `YYYY-MM-DD`, \\n\\ne.g. `1992-12-15`\",\n    \"5-1\": \"A binary document. Documents should be uploaded via the [Upload Document](doc:upload-document) API. The value returned by the API will be an array of document IDs associated with that Field.\\n\\nAll document IDs uploaded will be retained by the field until review. During review, invalid/unacceptable document IDs will be deleted. Once the field status is `APPROVED`, then only the actually approved document IDs shall remain.\",\n    \"6-1\": \"A Payment Method record. Payment methods are created using our Payment Method APIs. The value returned by the API will be a string containing the Payment Method ID associated with that Field\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]\n## Updating Fields\n\nWhen creating or updating an Account you do not need to submit the full Field object. Instead you can submit a simplified FieldUpdate object which only includes the `fieldId` and the `value`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"fieldId\\\": \\\"individualLegalName\\\",\\n  \\\"value\\\": \\\"Johnny Quest\\\"\\n}\\n// OR\\n{\\n  \\\"fieldId\\\": \\\"individualEmail\\\",\\n  \\\"value\\\": \\\"JohnnyQuest22@yolo.com\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"account-resource","type":"basic","title":"Account Overview"}
This represents the present state of an identifiable, KYC'able entity; either an [individual or a business](#section-account-types) based in a specific country for transacting with Wyre. It contains a collection of profile *Fields*, each holding a single datapoint and [field verification status](#section-field-statuses). Fields may be approved or rejected individually. This collection of fields contribute to the overall [account verification status](#section-account-status). Once all fields have been approved, the account will transition to approved and become eligible for transacting. Beyond KYC, each account may maintain a ledger balance with Wyre. Deposit addresses are provided for depositing into these ledger balances. [block:code] { "codes": [ { "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@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\t\t\t\t\"street1\": \"1 Market St\",\n\t\t\t\t\"street2\": \"Suite 402\",\n\t\t\t\t\"city\": \"San Francisco\",\n\t\t\t\t\"state\": \"CA\",\n\t\t\t\t\"postalCode\": \"94105\",\n\t\t\t\t\"country\": \"US\"\n\t\t},\n \"note\" : null,\n \"status\" : \"PENDING\"\n }, {\n \"fieldId\" : \"individualGovernmentId\",\n \"fieldType\" : \"DOCUMENT\",\n \"value\" : [],\n \"note\" : null,\n \"status\" : \"OPEN\"\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" } ] } [/block] ## Account Status Accounts can have one of 4 statuses: [block:parameters] { "data": { "0-0": "`OPEN`", "1-0": "`PENDING`", "2-0": "`APPROVED`", "3-0": "`CLOSED`", "h-0": "Status", "h-1": "Description", "0-1": "Waiting on action from you or the Account holder. \n\nThis is the initial state before all information has been submitted, or after any has failed to pass verifications.", "1-1": "Information has been fully submitted and is waiting on review from Wyre. The Account cannot yet transact.", "2-1": "Information has been reviewed and accepted by Wyre. The Account is now approved to transact.", "3-1": "The Account has been closed and may not transact" }, "cols": 2, "rows": 4 } [/block] ## Account Types Accounts can be of two different Types: [block:callout] { "type": "info", "title": "Note", "body": "Currently only `INDIVIDUAL` accounts are supported through our API." } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Description", "0-0": "`INDIVIDUAL`", "1-0": "`BUSINESS`", "0-1": "Used to register a personal account.", "1-1": "*Used to register a business entity account.*" }, "cols": 2, "rows": 2 } [/block] [block:api-header] { "title": "Fields" } [/block] Profile *Fields* are objects that each represent one KYC data point we collect on the Account, along with its present verification status. A Field has the following properties: [block:parameters] { "data": { "0-0": "`fieldId`", "1-0": "`fieldType`", "2-0": "`value`", "3-0": "`note`", "4-0": "`status`", "h-0": "Field Parameter", "h-1": "Description", "0-1": "The specific datapoint encapsulated by the Field. [See field IDs](#section-field-ids).", "1-1": "Defines the format and/or structure of the `value` parameter. [See types](#section-field-types)", "2-1": "A representation of the underlying KYC data. Actual format depends on `fieldType`", "4-1": "The current verification status of the field. [See statuses](#section-field-statuses)", "3-1": "A message to the accountholder regarding the field" }, "cols": 2, "rows": 5 } [/block] When the Account is created the `profileFields` array is automatically populated with all of the Fields that must be submitted in order for the Account to be approved and be able to transact. [block:code] { "codes": [ { "code": "{\n \"fieldId\" : \"individualResidenceAddress\",\n \"fieldType\" : \"ADDRESS\",\n \"value\" : {\n\t\t\t\t\"street1\": \"1 Market St\",\n\t\t\t\t\"street2\": \"Suite 402\",\n\t\t\t\t\"city\": \"San Francisco\",\n\t\t\t\t\"state\": \"CA\",\n\t\t\t\t\"postalCode\": \"94105\",\n\t\t\t\t\"country\": \"US\"\n\t\t},\n \"note\" : null,\n \"status\" : \"PENDING\"\n }", "language": "json" } ] } [/block] ## Field Statuses [block:parameters] { "data": { "h-0": "Status", "h-1": "Description", "0-0": "`OPEN`", "1-0": "`PENDING`", "2-0": "`APPROVED`", "0-1": "Waiting on action from you or the Account holder. \n\nThis is the initial state before any information has been submitted, or after it has failed to pass verifications.", "1-1": "Information has been fully submitted and is waiting on review from Wyre.", "2-1": "Information has been reviewed and accepted by Wyre." }, "cols": 2, "rows": 3 } [/block] ## Field IDs [block:parameters] { "data": { "h-0": "fieldId Value", "h-1": "Field Type", "0-0": "`individualLegalName`", "1-0": "`individualCellphoneNumber`", "2-0": "`individualEmail`", "3-0": "`individualResidenceAddress`", "4-0": "`individualGovernmentId`", "5-0": "`individualDateOfBirth`", "6-0": "`individualSsn`", "7-0": "`individualSourceOfFunds`", "0-1": "**STRING**", "1-1": "**CELLPHONE**", "2-1": "**EMAIL**", "3-1": "**ADDRESS**", "h-2": "Description", "0-2": "The full legal name of the account holder", "1-2": "the cellphone number of the account holder", "2-2": "the email address of the account holder", "3-2": "the residence address of the account holder", "4-1": "**DOCUMENT**", "5-1": "**DATE**", "6-1": "**STRING**", "7-1": "**PAYMENT_METHOD**", "4-2": "a scan or photo of a drivers license or passport of the account holder", "5-2": "the account holder's date of birth", "6-2": "the account holder's social security number", "7-2": "a payment method that the account holder owns.", "8-0": "`individualProofOfAddress`", "8-1": "**DOCUMENT**", "8-2": "a utility bill or bank statement. `individualProofOfAddress` will start in the `PENDING` state as we will attempt to use the `individualSourceOfFunds` to fill this requirement. If we aren’t able to verify the address from the user’s bank account we will mark the `individualProofOfAddress` field as `OPEN`. When this field is `OPEN`, the user should be displayed the note on the field and prompted to upload a document" }, "cols": 3, "rows": 9 } [/block] [block:callout] { "type": "info", "body": "Currently only INDIVIDUAL accounts are supported through our API.", "title": "Note" } [/block] ## Field Types [block:parameters] { "data": { "h-0": "fieldType value", "h-1": "Description", "0-0": "`STRING`", "1-0": "`CELLPHONE`", "2-0": "`EMAIL`", "3-0": "`ADDRESS`", "4-0": "`DATE`", "5-0": "`DOCUMENT`", "6-0": "`PAYMENT_METHOD`", "1-1": "A full cellphone number including country code\n\ne.g. `+15554445555`", "2-1": "A correctly formatted email address", "3-1": "An address object. Address format is:\n\n```json\n{\n\t\"street1\": \"1 Market St\",\n\t\"street2\": \"Suite 402\",\n\t\"city\": \"San Francisco\",\n\t\"state\": \"CA\",\n\t\"postalCode\": \"94105\",\n\t\"country\": \"US\"\n}\n```", "4-1": "Specifies a particular day. Format is `YYYY-MM-DD`, \n\ne.g. `1992-12-15`", "5-1": "A binary document. Documents should be uploaded via the [Upload Document](doc:upload-document) API. The value returned by the API will be an array of document IDs associated with that Field.\n\nAll document IDs uploaded will be retained by the field until review. During review, invalid/unacceptable document IDs will be deleted. Once the field status is `APPROVED`, then only the actually approved document IDs shall remain.", "6-1": "A Payment Method record. Payment methods are created using our Payment Method APIs. The value returned by the API will be a string containing the Payment Method ID associated with that Field" }, "cols": 2, "rows": 7 } [/block] ## Updating Fields When creating or updating an Account you do not need to submit the full Field object. Instead you can submit a simplified FieldUpdate object which only includes the `fieldId` and the `value`. [block:code] { "codes": [ { "code": "{\n \"fieldId\": \"individualLegalName\",\n \"value\": \"Johnny Quest\"\n}\n// OR\n{\n \"fieldId\": \"individualEmail\",\n \"value\": \"JohnnyQuest22@yolo.com\"\n}", "language": "json" } ] } [/block]