sign-up

dev-env-v1

https://btf-node.vercel.app/v1

POST

/auth/sign-up

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://btf-node.vercel.app/v1/auth/sign-up' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "telephone": "+2349012345678",
    "role": {
        "main": "rider",
        "category": "platform"
    },
    "password": "string",
    "location": {
        "city": "Ile - Ife (Off Campus)",
        "street": "Parakin",
        "description": "Beside AP filling station, KM 4, Ede Road"
    },
    "inviteCode": "string"
}'

Response Example

200 - Example 1

{
    "data": {
        "user": {
            "name": "string",
            "role": {
                "main": "rider",
                "category": "platform",
                "status": "pending"
            },
            "id": "string",
            "location": {
                "description": "Beside AP filling station, KM 4, Ede Road",
                "city": "Ile - Ife (Off Campus)",
                "street": "Parakin"
            },
            "active": true,
            "verified": true,
            "telephone": "+2349012345678",
            "review": {
                "rating": 0,
                "totalRaters": 0
            },
            "delivery": {
                "price": {
                    "min": {
                        "currency": "ngn",
                        "amount": 0
                    }
                },
                "time": {
                    "min": 0,
                    "max": 0
                }
            },
            "viewer": {},
            "store": {
                "name": "string",
                "category": "string",
                "availability": {
                    "weekly": {
                        "sun": {
                            "start": "17:00:00",
                            "end": "17:00:00"
                        },
                        "mon": {
                            "start": "17:00:00",
                            "end": "17:00:00"
                        },
                        "tue": {
                            "start": "17:00:00",
                            "end": "17:00:00"
                        },
                        "wed": {
                            "start": "17:00:00",
                            "end": "17:00:00"
                        },
                        "thur": {
                            "start": "17:00:00",
                            "end": "17:00:00"
                        },
                        "fri": {
                            "start": "17:00:00",
                            "end": "17:00:00"
                        },
                        "sat": {
                            "start": "17:00:00",
                            "end": "17:00:00"
                        }
                    },
                    "timezoneOffset": 0
                },
                "location": {
                    "description": "Beside AP filling station, KM 4, Ede Road",
                    "city": "Ile - Ife (Off Campus)",
                    "street": "Parakin"
                },
                "logo": {
                    "mimeType": "string",
                    "url": "string"
                },
                "menu": {
                    "pack": {
                        "price": {
                            "currency": "ngn",
                            "amount": 0
                        }
                    }
                }
            },
            "bank": {
                "name": "United Bank of Africa",
                "account": {
                    "name": "Ajanle Koko Usman",
                    "number": "220123698521"
                }
            },
            "vendor": {
                "name": "string",
                "role": {
                    "main": "rider",
                    "category": "platform",
                    "status": "pending"
                },
                "id": "string",
                "location": {
                    "description": "Beside AP filling station, KM 4, Ede Road",
                    "city": "Ile - Ife (Off Campus)",
                    "street": "Parakin"
                },
                "active": true,
                "verified": true,
                "telephone": "+2349012345678",
                "review": {
                    "rating": 0,
                    "totalRaters": 0
                },
                "delivery": {
                    "price": {
                        "min": {
                            "currency": "ngn",
                            "amount": 0
                        }
                    },
                    "time": {
                        "min": 0,
                        "max": 0
                    }
                },
                "viewer": {},
                "store": {
                    "name": "string",
                    "category": "string",
                    "availability": {
                        "weekly": {
                            "sun": {
                                "start": "17:00:00",
                                "end": "17:00:00"
                            },
                            "mon": {
                                "start": "17:00:00",
                                "end": "17:00:00"
                            },
                            "tue": {
                                "start": "17:00:00",
                                "end": "17:00:00"
                            },
                            "wed": {
                                "start": "17:00:00",
                                "end": "17:00:00"
                            },
                            "thur": {
                                "start": "17:00:00",
                                "end": "17:00:00"
                            },
                            "fri": {
                                "start": "17:00:00",
                                "end": "17:00:00"
                            },
                            "sat": {
                                "start": "17:00:00",
                                "end": "17:00:00"
                            }
                        },
                        "timezoneOffset": 0
                    },
                    "location": {
                        "description": "Beside AP filling station, KM 4, Ede Road",
                        "city": "Ile - Ife (Off Campus)",
                        "street": "Parakin"
                    },
                    "logo": {
                        "mimeType": "string",
                        "url": "string"
                    },
                    "menu": {
                        "pack": {
                            "price": {
                                "currency": "ngn",
                                "amount": 0
                            }
                        }
                    }
                }
            }
        },
        "tokens": {
            "access": "string",
            "refresh": "string"
        }
    }
}

Request

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400400 - bad request

Modified at 2025-08-07 06:22:42

reset password

sign-in