post
https://revamp-api.edfapay.com/public/signup
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Register a new merchant onboarding request.
This API is used to submit merchant details and required documents for onboarding.
Endpoint
POST https://demo-api.edfapay.com/public/signup
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| fullName | String | Yes | Merchant full name |
| companyName | String | Yes | Company name |
| address | String | Yes | Address |
| companyWebsite | String | No | Website |
| String | Yes | ||
| mobileNumber | String | Yes | Phone |
| ibanNumber | String | Yes | IBAN |
| nationalId | String | Yes | National ID |
| isFreeLance | Boolean | Yes | Freelancer flag |
| userType | String | Yes | User type |
| merchantOnboardDocumentsRequests | Array | Yes | Documents list |
Request Example
curl --location '{{base_url}}/public/signup' \
--header 'Content-Type: application/json' \
--data '{
"fullName": "Test User",
"companyName": "Test Company",
"address": "Riyadh",
"companyWebsite": "https://example.com",
"email": "[email protected]",
"ibanNumber": "SA0000000000000000000000",
"mobileNumber": "+966-500000000",
"nationalId": "1234567890",
"isFreeLance": true,
"userType": "FreeLance",
"merchantOnboardDocumentsRequests": [
{
"name": "CR_CERTIFICATE_doc",
"type": "CR_CERTIFICATE",
"data": {
"fileSize": 12345,
"fileName": "cr.pdf",
"contentType": "application/pdf",
"base64": "BASE64_DATA"
}
}
]
}'Response Body
| Field | Type | Description |
|---|---|---|
| code | Integer | Status |
| message | String | Response message |
| data | Object | Onboarding data |
Response Example
{
"code": 200,
"message": "Success",
"errorCode": null,
"data": "Successfully created"
}Note
Documents must be sent as Base64 encoded files