Quickstart

to get started with the boom api, follow these 3 steps 1\ generate an access key and a secret key using the boom partner platform in the boom partner platform, navigate to "settings" > "developers" to generate an access key and a secret key make sure to save the secret key after you generate it, as you won't be able to view it again in the partner platform 2\ exchange your access key and secret key for an api token curl location request post 'https //api sandbox boompay app/partner/v1/authenticate' \\ \ header 'content type application/json' \\ \ data raw '{ "access key" "sample access key", "secret key" "sample secret key" }' 3\ create a customer authentication token and sync with boom's user database curl location request post 'https //api sandbox boompay app/partner/v1/customers' \\ \ header 'authorization bearer \<api token>' \\ \ header 'content type application/json' \\ \ data raw '{ "first name" "john", "last name" "doe", "email" "uniquejohndoe\@boompay app", "phone" "12345678910" }' 4\ (optional) create an enrollment in case you would like to enhance user experience by prefilling required data on behalf of the customer, you can send available data before customers start their flow customers will see those fields prefilled and it will simplify the enrollment flow note customer id and address are required fields, others optional curl location request post 'https //api sandbox boompay app/partner/v1/enrollments' \\ \ header 'authorization bearer \<api token>' \\ \ header 'content type application/json' \\ \ data raw '{ "customer id" "id", # from the previous call "move in date "2024 01 21", "lease end date" "2025 01 21" , "lease month to month" false, # either month to month or lease end date "monthly rent amount" 1234, "address" { "address1" "123 main st", "address2" "unit b", "city" "new york", "state or province" "ny", "postal code" "12345" }' 5\ (optional) sumbit an enrollment in the case that you have all of the nessecary information for enrollment you can provide all the data points required for enrollment, customers will skip enrollment flow and once the sdk is loaded the customer will land on the dashboard note in order to submit enrollment, all the fields, including optional ones in create enrollment api need to be filled refer to api reference docid\ a3 edi3zwdzp hgktuo u in order to see how to patch optional fields curl location request post 'https //api sandbox boompay app/partner/v1/enrollments/\ enrollment id/enroll' \\ \ header 'authorization bearer \<api token>' \\ \ header 'content type application/json' \ }' email and phone must be unique, meaning neither element should be present in boom's system