Skip to main content

Save Non Registered User API

Overview​

Store non-registered user information in the system. This API is used to capture user details before they complete the full registration process.

API Details​

Endpoint​

POST https://api.gafapay.com/gafapay/v3/user/non_registered_user

Headers​

authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3MDA3NDEyfQ.ph7qKBEzuHxgljV3141L9iOrWmHI4TnyoknBSNoVYYU
companyid: 59388167894b4d10a04fe5da3b8a2104
requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b
Content-Type: application/json

Request Body​

{
    "phone_number": "9876543210",
    "full_name": "John Doe",
    "address": "123 Main Street, City, Country",
    "dob": 631152000
}

Request Body Fields​

Required Fields​

  • phone_number (string, required): User's phone number

    • Format: Numeric string
    • Example: "9876543210", "1234567890"
    • Minimum length: 7 characters
    • Maximum length: 15 characters

  • company_id (string, required): Company identifier

    • This is automatically set from the request header companyid
    • Example: "59388167894b4d10a04fe5da3b8a2104"
Optional Fields​

  • full_name (string, optional): User's full name

    • Example: "John Doe", "Jane Smith"
    • Can be null if not provided

  • address (string, optional): User's address

    • Example: "123 Main Street, City, Country"
    • Can be null if not provided

  • dob (long, optional): Date of birth as Unix timestamp (epoch seconds)

    • Example: 631152000 (represents a specific date)
    • Format: Unix timestamp in seconds
    • Can be null if not provided

Common Request Fields (Automatically Set)​

The following fields are automatically populated from request headers:

  • company_id: Set from companyid header
  • request_id: Set from requestid header
  • ip_address: Set from remoteAddress header
  • language: Set from Language header (defaults to "en-US")
  • token_user_id: Set from token_user_id header

Response​

{
    "success": 1,
    "error": [],
    "data": {
        "non_registered_user_id": "6f1b82443e524459831de59d430a0c41",
        "message": "USER_NON_REGISTERED_USER_SAVED_SUCCESSFULLY"
    }
}

Response Fields​

  • success (integer): Response status indicator
    • 1 = Success
    • 0 = Failure
  • error (array): Array of error messages (empty on success)
  • data (object): Response data object
    • non_registered_user_id (string): Unique identifier of the saved non-registered user
    • message (string): Success message indicating the user was saved successfully

Example Usage​

Basic Request with Required Fields Only​

curl --location 'https://api.gafapay.com/gafapay/v3/user/non_registered_user' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3MDA3NDEyfQ.ph7qKBEzuHxgljV3141L9iOrWmHI4TnyoknBSNoVYYU' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b' \
--header 'Content-Type: application/json' \
--data '{
    "phone_number": "9876543210"
}'

Complete Request with All Fields​

curl --location 'https://api.gafapay.com/gafapay/v3/user/non_registered_user' \
--header 'authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJlNDk0Njg3N2YxODk0NmIyOTlmZGRmMGYyMTMzZGNiYSIsInJvbGVzIjpbIlJPTEVfQURNSU4iXSwiZXhwIjoxNzU3MDA3NDEyfQ.ph7qKBEzuHxgljV3141L9iOrWmHI4TnyoknBSNoVYYU' \
--header 'companyid: 59388167894b4d10a04fe5da3b8a2104' \
--header 'requestid: be08f79e-7eac-40e1-acbe-00f6ae7b8f7b' \
--header 'Content-Type: application/json' \
--data '{
    "phone_number": "9876543210",
    "full_name": "John Doe",
    "address": "123 Main Street, City, Country",
    "dob": 631152000
}'