Create Address

Create an address for getting rates or arranging pickup and delivery.

/addresses

POST https://api.terminal.africa/v1/addresses

This endpoint allows you to add a new address to your account.

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY
Content-Type	String	Set value to application/json

Request Body

Name	Type	Description
city*	String	Address city.
country*	String	ISO 2 country code for address.
email	String	Email of person at address.
first_name	String	First name of person at address. Required for arranging pickup / delivery.
is_residential	Boolean	Indicates if address is a residential address or not. Defaults to true.
last_name	String	Last name of person at address. Required for arranging pickup / delivery.
line1	String	Street address. Required for arranging pickup / delivery.
line2	String	Second line of street address.
metadata	Object	Additional information for an address.
name	String	Full name of person at address.
phone	String	Phone number of person at address. Required for arranging pickup / delivery.
state*	String	Address state
zip	String	Zip / Postal code. Required for arranging pickup / delivery.

200 Address created successfully.

{
	status: true,
	message: 'Address created successfully',
	data: {
		address_id: 'AD-00632494667',	
		city: 'Lagos',
		coordinates: {
				lat: 6.5969424,
				lng: 3.3542992
		},	
		country: 'NG',
		email: '[e-mail]',
		first_name: 'Augustus',
		is_residential: true,
		last_name: 'Obi',
		line1: '1121 Allen Avenue, Ikeja',
		line2: '',
		metadata: {
			my_app_customer_id: 11234
		},
		name: 'Augustus Obi',
		phone: '[phone]',
		state: 'Lagos',
		zip: '121006',
		created_at: '2021-07-13T20:25:53.011Z',
		updated_at: '2021-07-13T20:25:53.011Z'
	}
}