{"docs":{"name":"Bloom","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/developers/1","api_url":"/api","resources":[{"doc_url":"/developers/1/senders","id":"senders","api_url":"/api","name":"Senders","short_description":null,"full_description":null,"version":"1","formats":null,"metadata":null,"methods":[{"doc_url":"/developers/1/senders/index","name":"index","apis":[{"api_url":"/api/v1/partners/:api_token/senders","http_method":"GET","short_description":"Show a list of senders belonging to this partner","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn a list of senders created by this partner, sorted by newest first.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/senders\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/senders/show","name":"show","apis":[{"api_url":"/api/v1/partners/:api_token/senders/:id","http_method":"GET","short_description":"Show a user belonging to this partner","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/senders/:id\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/senders/find_by_email","name":"find_by_email","apis":[{"api_url":"/api/v1/partners/:api_token/senders/find_by_email","http_method":"GET","short_description":"Show a sender belonging to this partner by supplying their email address","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/senders/find_by_email?email=helloluis%40me.com\n(Don't forget to escape the email string!)\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/senders/find_by_mobile","name":"find_by_mobile","apis":[{"api_url":"/api/v1/partners/:api_token/senders/find_by_mobile","http_method":"GET","short_description":"Show a sender belonging to this partner by supplying their mobile","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eFor best results, format your mobile number like this: +639178881111\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/senders/find_by_mobile?mobile=+639178329098\n(Don't forget to escape the plus symbol!)\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/senders/create","name":"create","apis":[{"api_url":"/api/v1/partners/:api_token/senders","http_method":"POST","short_description":"Create a new user under this partner","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreate a new user account under this partner. This returns a 8-character randomly-generated password that you may pass on to your user or store for later use. (The password is not required in order to send remittances.)\u003c/p\u003e\n\n\u003cp\u003eTake note of the ID parameter in the returned User hash, it is how you will access this same user later on.\u003c/p\u003e\n","errors":[],"params":[{"name":"agent_id","full_name":"agent_id","description":"\n\u003cp\u003eThe id of the Agent that this user belongs to. If you don’t include this, we will automatically assign this user to the first Agent record that belongs to this partner.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender","full_name":"sender","description":"\n\u003cp\u003eSender Information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"first_name","full_name":"sender[first_name]","description":"\n\u003cp\u003eFirst name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"sender[last_name]","description":"\n\u003cp\u003eLast name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"sender[email]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mobile","full_name":"sender[mobile]","description":"\n\u003cp\u003eMobile number\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address","full_name":"sender[address]","description":"\n\u003cp\u003eResidential address\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"sender[city]","description":"\n\u003cp\u003eCity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country","full_name":"sender[country]","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"postal_code","full_name":"sender[postal_code]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"identification","full_name":"sender[identification]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"url","full_name":"sender[identification][url]","description":"\n\u003cp\u003eURL string pointing to a static image of the user’s passport, driver’s license, or other government-issued ID. (Ex. http ://aws.amazon.com/image.jpg)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"proof_of_address","full_name":"sender[proof_of_address]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"url","full_name":"sender[proof_of_address][url]","description":"\n\u003cp\u003eURL string pointing to a static image of the user’s utility bill, bank statement, or other third-party-issued document with residential address prominently indicated. (Ex. http ://aws.amazon.com/image.jpg)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"birthdate","full_name":"sender[birthdate]","description":"\n\u003cp\u003eBirthdate.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/senders\n\n{\n  agent_id: \"12345-54321\",\n  sender: {\n    first_name: \"Luis\",\n    last_name:  \"Buenaventura\",\n    email:      \"luis@www.bloomremit.net\",\n    mobile:     \"+639175551111\",\n    address:    \"251 Salcedo St., Legaspi Village\",\n    city:       \"Makati City\",\n    country:    \"PH\",\n    postal_code: \"1600\",\n    identification: {\n      url: \"http://aws.amazon.com/bucket/image.jpg\"\n    }\n  }\n}\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/senders/update","name":"update","apis":[{"api_url":"/api/v1/partners/:api_token/senders/:id","http_method":"PUT","short_description":"Update the attributes of a user belonging to this partner","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate user profile information. Note that a user’s email address is not editable. When changing a user’s password, use the /senders/:id/update_password call.\u003c/p\u003e\n","errors":[],"params":[{"name":"user","full_name":"user","description":"\n\u003cp\u003eUser Information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"first_name","full_name":"user[first_name]","description":"\n\u003cp\u003eFirst name; defaults to ‘Guest’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"user[last_name]","description":"\n\u003cp\u003eLast name; defaults to ‘Customer’\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"user[email]","description":"\n\u003cp\u003eEmail\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mobile","full_name":"user[mobile]","description":"\n\u003cp\u003eMobile number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address","full_name":"user[address]","description":"\n\u003cp\u003eResidential address\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"user[city]","description":"\n\u003cp\u003eCity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"country","full_name":"user[country]","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"postal_code","full_name":"user[postal_code]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"identification","full_name":"user[identification]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"url","full_name":"user[identification][url]","description":"\n\u003cp\u003eURL string pointing to a static image of the user’s passport, driver’s license, or other government-issued ID. This is required for sending limits above PhP50,000.00 (Ex. http://aws.amazon.com/image.jpg)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"proof_of_address","full_name":"user[proof_of_address]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"url","full_name":"user[proof_of_address][url]","description":"\n\u003cp\u003eURL string pointing to a static image of the user’s utility bill, bank statement, or other third-party-issued document with residential address prominently indicated. This is required for sending limits above PhP150,000.00 (Ex. http://aws.amazon.com/image.jpg)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"birthday","full_name":"user[birthday]","description":"\n\u003cp\u003eBirthdate. This is required for sending limits above PhP150,000.00 (Ex. http://aws.amazon.com/image.jpg)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/senders\n\n{\n  user: {\n    first_name: \"Luis\",\n    last_name:  \"Buenaventura\",\n    mobile:     \"+639175551111\",\n    address:    \"251 Salcedo St., Legaspi Village\",\n    city:       \"Makati City\",\n    country:    \"PH\",\n    postal_code: \"1600\",\n    identification: {\n      url: \"http://aws.amazon.com/bucket/image.jpg\"\n    }\n  }\n}\n\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/senders/destroy","name":"destroy","apis":[{"api_url":"/api/v1/partners/:api_token/senders/:id","http_method":"DELETE","short_description":"Delete a sender belonging to this partner","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eSafely delete a user. This will also cascade down to the sender’s recipients.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null}]}}