Gouranger API - Documentation

Introduction

The Gouranger API is structured around REST principles, featuring predictable resource-oriented URLs. It accepts form-encoded request bodies, returns JSON-encoded responses, and employs standard HTTP response codes, along with authentication and verbs.

Integrate your product seamlessly into the workflows of devoted users by utilizing the Gouranger Attorney API. This allows you to access Process Server Portals and place orders with corresponding document types.

Getting started

Begin by registering a new account on the Gouranger website. Next, familiarize yourself with the process of making requests for the resources you need through our HTTP APIs. Once your integration is finalized and ready for deployment, showcase it in our integrations directory to reach and engage with the community.

cURL
PHP


curl --version


npm install @example/gouranger-api --save


pip install gouranger_api


composer require gouranger/sdk

Authentication Introduction

Authentication is mandatory for all endpoints in the Gouranger API.

Prior to authentication, ensure you have logged in. Access to the sandbox API is available for all resources.

Make all API requests using HTTPS requests through plain HTTP will fail. Similarly, any API requests lacking authentication will result in failure.

API Key

API key authentication serves as a straightforward authentication mechanism, offering an easy alternative to OAuth for connecting to and authenticating Gouranger's API services. Ensure the API is generated from the attorney website.

The generated API keys can exist in either the Live or Sandbox environment. we can generate multiple keys, but the usage limit is one key per environment.

LIVE
SANDBOX

#--base_url
												
https://portal.gouranger.com/api/v1

#--base_url

https://www.gouranger.info/api/v1

By default, all scopes are included when generating an API key, and as of now, customization of scopes is not available.

Generate API key

Gouranger’s Web API v1 provides support for API Keys, offering an alternative method of authentication distinct from your account username and password. API Keys enhance the security of your account, and you can assign specific permissions to control access to different areas of your account. Generate API Keys directly within your account.

1. Navigate to the API Keys menu item in the website's left navigation pane from Profile Settings and select it. API Key.

2. Click the Generate API Key button.

3.You will receive a success message upon generating the API Key.

4. To add additional keys, generate them by clicking the Add Additional API Key button.

5. After creating a key, enable its status by clicking the Status toggle to ON. Note that only one API key can be active at a time.

6. Copy the API key, which is in Active Status, to configure it in the HTTP request body from your application.

Usage

POST {base_url} /authenticate

To make an HTTP request with the API Key, ensure the request parameter includes the API-KEY. Use the generated API key in the following format.

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/authenticate'
--form 'api_key="43c1d2ea8c154f1011eeaeb131f225f6b0a9fb194e734c3182ad028718a5e002"'



$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.gouranger.info/api/v1/authenticate',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('api_key' => '43c1d2ea8c154f1011eeaeb131f225f6b0a9fb194e734c3182ad028718a5e002'),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Request body

api_key
INTEGER REQUIRED

A valid API keyis generated by the Attorney in the Gouranger Website.

Responses

If the API key is valid and matches the exact API key, a success response is sent with a Bearer Token. Use the generated Bearer Token for further authentication.

If the API key is incorrect, an unauthorized response is provided.


{
    "code": "200",
    "message": "Token Generated Successfully",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjM3NTIwMCwiZXhwIjoxNzAyMzc4ODAwLCJuYmYiOjE3MDIzNzUyMDAsImp0aSI6ImE1MjlCbWs2VXVkN25uZkQiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.CLBLG0vZ1ODREvRuedOf0FKJnhtvUu_aaqScB1Fl3pc"
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The api key field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The api key field is required.",
            "code": "1002"
        }
    }
}

Errors

Gouranger employs standard HTTP response codes to convey the success or failure of an API request.

Generally, codes in the 2xx range indicate success, while codes in the 4xx range signal errors, often due to missing or incorrect information (e.g., an omitted required parameter, a failed charge, etc.).

Codes in the 5xx range are rare and indicate an error with Gouranger's servers.

Some 4xx errors, which could be handled programmatically (e.g., a declined card), include an error code that provides a brief explanation of the reported issue.

HTTP STATUS CODES

#CODE               RESPONSE                    DESCRIPTION
												
200                  OK	                        Everything worked as expected.
400                  Bad Request	        The request was unacceptable, often due to missing a required parameter.
401                  Unauthorized	        No valid API key provided.
402                  Request Failed	        The parameters were valid but the request failed.
403                  Forbidden	                The API key doesn't have permissions to perform the request.
404                  Not Found	                The requested resource doesn't exist.
409                  Conflict	                The request conflicts with another request (perhaps due to using the same idempotent key).
429                  Too Many Requests	        Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504   Server Errors	        Something went wrong on Gouranger's end. (These are rare.)

Court Details

The "Get Court Details" API is primarily designed to facilitate interactions with the Gouranger application, allowing the retrieval and display of process server companies registered in the Gouranger account.

Default Token

Retrieving court details doesn't require logging in with an API key. Instead, a default token is utilized for this purpose. Default tokens are generated from the admin panel, and for obtaining one, please contact the Gouranger Administrator.

Get Court Details

GET {base_url} /getCourtDetails

All process server companies registered in the Gouranger account will be displayed.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/getCourtDetails?default_token=09554919d584b9bac38c99eee10dd7c6cf4c03defe3130235ac3e9d611f9da22' \
	--header 'default_token: 09554919d584b9bac38c99eee10dd7c6cf4c03defe3130235ac3e9d611f9da22'



	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/getCourtDetails?default_token=09554919d584b9bac38c99eee10dd7c6cf4c03defe3130235ac3e9d611f9da22',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'GET',
	  CURLOPT_HTTPHEADER => array(
		'default_token: 09554919d584b9bac38c99eee10dd7c6cf4c03defe3130235ac3e9d611f9da22'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Request body

default_token
INTEGER REQUIRED

The default token is generated from the admin panel.

Example response

If the default token is valid and matches the exact token, a success response is sent with court details. Utilize these court details for further processes.

If the default token is incorrect, an unauthorized response is provided.


{
    "code": "200",
    "message": "Court Details Fetched Successfully",
    "data": [
        [
            {
                "Court ID": 1,
                "Court Name": "34th District Court"
            },
			{
                "Court ID": 2,
                "Court Name": "37th District Court"
            }
        ]
    ]
}


{
    "code": 404,
    "message": "Requested url is not found",
    "data": {
        "error": {
            "user_message": "Requested url is not found",
            "internal_message": "Requested url is not found or invalid request method provided",
            "code": "1005"
        }
    }
}


{
    "code": "400",
    "message": "The api key field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The api key field is required.",
            "code": "1002"
        }
    }
}

Attorney Profile

The user's APIs are primarily used to interact with the Gouranger application to create, send, and manage documents. This section demonstrates how to get user details, update user detailes, add new order and manage user orders. Users can be created programmatically or via the Gouranger web interface and they can be used by your application.

Get Profile

GET {base_url} /getUserProfile

The "Get Profile" API is used to retrieve details of the logged-in user from the Gouranger account using their unique tokens.

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. Requests without authentication will result in failure.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Code snippet

cURL
PHP


curl --location --request GET 'https://www.gouranger.info/api/v1/getUserProfile' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'




$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.gouranger.info/api/v1/getUserProfile',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Request body

This API does not require any request parameters.

Example Responses

If the Bearer Token is valid and matches the logged-in user, a success response is returned with the corresponding user details.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Profile Details Fetched Successfully",
    "data": [
        [
            {
                "Attorney ID": 1,
                "First Name": "Robert",
                "Last Name": "Curtis",
                "Company Name": "Linnell & Associates",
                "Contact Number": "(789) 765-5432",
                "Email Address": "rcurtis@robertjcurtislaw.com",
                "Address": "17557 Wayne Road",
                "Country": "United States",
                "State": "District of Columbia",
                "City": "Livonia",
                "Postal Code": "48152",
                "Email Notification": "OFF",
                "Additional Emails": "robertjcurtis@yahoo.com"
            }
          ]
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The Bearer Token field is required",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The Bearer Token field is required",
            "code": "1002"
        }
    }
}

Update Profile

POST {base_url} /updateUserProfile

The "Update Profile" API is used to modify the details of the logged-in user in the Gouranger account using their unique tokens.

If the token is incorrect, an unauthorized response is generated.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/updateUserProfile' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYzNzY1OSwiZXhwIjoxNzAyNjQxMjU5LCJuYmYiOjE3MDI2Mzc2NTksImp0aSI6InhDVzhyN0xXc3lRRkt3blAiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.E1ydn1FHSl9hoPPZ-lbfxF7ksxpo_c-0Z4M3JUWdO2A' \
	--form 'first_name="Robert"' \
	--form 'last_name="Curtis"' \
	--form 'email="rcurtis@robertjcurtislaw.com"' \
	--form 'company_name="Linnell & Associates"' \
	--form 'contact_number="7897655432"' \
	--form 'location="17557 Wayne Road"' \
	--form 'country="United States"' \
	--form 'state="District of Columbia"' \
	--form 'city="Livonia"' \
	--form 'postal_code="48152"' \
	--form 'email_permission="1"' \
	--form 'secondary_email="robertjcurtis@yahoo.com"' \
	--form 'additional_email="rcurtis@rocketeerbusinessplans.com"'




	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/updateUserProfile',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'POST',
	  CURLOPT_POSTFIELDS => array('first_name' => 'Robert','last_name' => 'Curtis','email' => 'rcurtis@robertjcurtislaw.com','company_name' => 'Linnell & Associates','contact_number' => '7897655432','location' => '17557 Wayne Road','country => 'United States','state => 'District of Columbia','city => 'Livonia','postal_code => '48152','email_permission' => '1','secondary_email' => 'robertjcurtis@yahoo.com','additional_email' => 'rcurtis@rocketeerbusinessplans.com'),
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYzNzY1OSwiZXhwIjoxNzAyNjQxMjU5LCJuYmYiOjE3MDI2Mzc2NTksImp0aSI6InhDVzhyN0xXc3lRRkt3blAiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.E1ydn1FHSl9hoPPZ-lbfxF7ksxpo_c-0Z4M3JUWdO2A'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

first_name
STRING REQUIRED

The first name of the user.
last_name
STRING REQUIRED

The last name of the user.
email
STRING REQUIRED

The email of the user.
company_name
STRING REQUIRED

The company name of the user.
contact_number
INTEGER REQUIRED

The contact number of the user.
location
STRING REQUIRED

The location of the user.

Example: 17557 Wayne Road
country
STRING REQUIRED

The country of the user.

Example: United States
state
STRING REQUIRED

The state of the user.

Example: District of Columbia
city
STRING REQUIRED

The city of the user.

Example: Livonia
postal_code
STRING REQUIRED

The postal code of the user.

It must be 5 digits. Example: 48152
email_permission
INTEGER OPTIONAL

The email permission of the user.

Example: 1 represents ON and 0 represents OFF for Email Permission.
secondary_email
STRING OPTIONAL

The secondary email of the user.

If the Email Permission is ON, then the secondary email is mandatory.
additional_email
STRING OPTIONAL

The additional emails of the user.
.

Example response

If the Bearer Token is valid and matches the logged-in user, a success response is returned, indicating the successful update of the user profile with the provided details.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Profile Details Updated Successfully",
    "data": []
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorized",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The secondary mobile field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The secondary mobile field is required.",
            "code": "1002"
        }
    }
}

Attorney Payment Card

The Attorney Payment Card APIs are primarily designed for creating and managing user cards. This section demonstrates how to obtain card details, check user cards, add new cards, and manage existing ones. User cards can be saved and used for payment as well as adding new customer orders.

Get Cards

GET {base_url} /getCards

The "Get Card" API is utilized to list all user-saved cards in their Gouranger account, providing access to their unique card details.

All newly created cards will be visible in the Gouranger account.

Code snippet

cURL
PHP


curl --location --request GET 'https://www.gouranger.info/api/v1/getCards' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'




$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.gouranger.info/api/v1/getCards',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

This API does not require any request parameters.

Example Responses

If the Bearer Token is valid and matches the logged-in user, a success response is returned with the corresponding user's card details.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Card Details Fetched Successfully",
    "data": [
        [
            {
                "Card ID": "card_1OGKQJAkZSJcydc6fmK17lRa",
                "Card Type": "Visa",
                "Country": "US",
                "Expiry Month": "9",
                "Expiry Year": "2026",
                "Last 4 digits": "4242"
            }
        ]
    ]
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The Bearer Token field is required",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The Bearer Token field is required",
            "code": "1002"
        }
    }
}

Save Card

POST {base_url} /saveCard

The "Save Card" API is employed to create a new user card within their Gouranger organization, utilizing unique card details if they don't already possess one. Users can create a maximum number of cards based on their needs.

All newly created cards will be visible in the Gouranger account.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/saveCard' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs' \
--form 'card_number="4242424242424242"' \
--form 'cvv="214"' \
--form 'card_expiry_month="09"' \
--form 'card_expiry_year="2027"'




$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.gouranger.info/api/v1/saveCard',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('card_number' => '4242424242424242','cvv' => '214','card_expiry_month' => '09','card_expiry_year' => '2027'),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

card_number
INTEGER REQUIRED

The card number of the card.

The card number must fall within the range of 15 to 19 digits. Example: 4242 4242 4242 4242
cvv
INTEGER REQUIRED

The cvv number of the card.

It must be either 3 or 4 digits. Example: 2313 or 231
card_expiry_month
INTEGER REQUIRED

The expiry month of the card.

It must be 2 digits. Example: 09
card_expiry_year
INTEGER REQUIRED

The expiry year of the card. The year must be in the future.

It must be 4 digits. Example: 2026

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API saves the provided user card details with a success response.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Attorney Payment Card Details Saved Successfully",
    "data": []
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The card number must not be greater than 16 characters.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The card number must not be greater than 16 characters.",
            "code": "1002"
        }
    }
}

Check Card

POST {base_url} /checkCard

The "Check Card" API is utilized to verify the user card within their Gouranger organization using unique card details.

If the card is invalid, an error response is returned.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/checkCard' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDExNTAzMjEsImV4cCI6MTcwMTE1MzkyMSwibmJmIjoxNzAxMTUwMzIxLCJqdGkiOiJoSFhRWlYwNnJnVEVTU3lUIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.FgmYapjl2jziAPtEbQvWVS8QC0UdhdEfpbNSpzbsA_I' \
--form 'card_id="card_1OGm86AkZSJcydc6IcuqF2N7"'




$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.gouranger.info/api/v1/checkCard',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('card_id' => 'card_1OGm86AkZSJcydc6IcuqF2N7'),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDExNTAzMjEsImV4cCI6MTcwMTE1MzkyMSwibmJmIjoxNzAxMTUwMzIxLCJqdGkiOiJoSFhRWlYwNnJnVEVTU3lUIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.FgmYapjl2jziAPtEbQvWVS8QC0UdhdEfpbNSpzbsA_I'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

card_id
INTEGER REQUIRED

The card id of the user.

You can obtain the Card ID from the Get Cards API .

Example Responses

If the Bearer Token valid and matches with the logged in user, it sends response whether the given card details are valid or not.

It gives unauthorize response if the token is wrong.


{
    "code": "200",
    "message": "Card Valid",
    "data": []
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "500",
    "message": "Something went wrong! Please try again later.",
    "data": {
        "error": {
            "user_message": "Something went wrong. Kindly report on this.",
            "internal_message": "Selected Card was Invalid or it was Deleted!",
            "code": "1003"
        }
    }
}

Delete Card

DELETE {base_url} /deleteCard

The "Delete Card" API is employed to delete the user card with the provided card ID.

If the card is invalid, an error response is returned.

Code snippet

cURL
PHP


curl --location --request DELETE 'https://www.gouranger.info/api/v1/deleteCard?card_id=card_1OHKOsAkZSJcydc6Qyf2RNco' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'




	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/deleteCard?card_id=card_1OHKOsAkZSJcydc6Qyf2RNco',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'DELETE',
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

card_id
INTEGER REQUIRED

The card id of the user.

You can obtain the Card ID from the Get Cards API.

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API removes the card details of the corresponding user with a success response.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Attorney Payment Card Details Deleted Successfully",
    "data": []
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "500",
    "message": "Something went wrong! Please try again later.",
    "data": {
        "error": {
            "user_message": "Something went wrong. Kindly report on this.",
            "internal_message": "Selected Card was Invalid or it was Deleted!",
            "code": "1003"
        }
    }
}

Attorney New Order

The Attorney New Order APIs are primarily designed for adding and managing user orders. This section demonstrates how to obtain order details, add new orders, and manage existing ones. Attorney Payment Cards can be saved and utilized for payment as well as adding new customer orders.

Get Document Details

GET {base_url} /getDocumentDetails

The "Get Document Details" API is employed to list all document types corresponding to the selected court in the user's Gouranger account.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/getDocumentDetails?court_id=1' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYxNDE1MywiZXhwIjoxNzAyNjE3NzUzLCJuYmYiOjE3MDI2MTQxNTMsImp0aSI6InIxZUt2SzdFQzloUVJLdEUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.Ax-gUGtxY4aGxpO_taTWpx9U6CS9BFhRRPqa_5n6DjU'



	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/getDocumentDetails?court_id=1',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'GET',
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYxNDE1MywiZXhwIjoxNzAyNjE3NzUzLCJuYmYiOjE3MDI2MTQxNTMsImp0aSI6InIxZUt2SzdFQzloUVJLdEUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.Ax-gUGtxY4aGxpO_taTWpx9U6CS9BFhRRPqa_5n6DjU'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

court_id
INTEGER REQUIRED

The court id of the user.

You can obtain the Court ID from the Get Court Details API.

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API sends a success response with the corresponding document type details for the given court ID.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Document Types Listed Sucessfully",
    "data": {
        "Document Pricing": [
            {
                "Document Name": "Summons & Complaint Landlord Tenant (37th DC)",
                "Service Fee": "$ 34.00 Per Defendant",
                "Mileage": "No Charge",
                "Print Fee": "$ 0.10 Per Page",
                "Admin Fee (%)": 13
            },
            {
                "Document Name": "Summons & Complaint General Civil (All Courts)",
                "Service Fee": "$ 34.00 Per Defendant",
                "Mileage": "$0.98 Per Mile",
                "Print Fee": "$ 0.10 Per Page",
                "Admin Fee (%)": 13
            },
            {
                "Document Name": "Application and Order of Eviction (37th DC)",
                "Service Fee": "$ 45.00 Per Defendant",
                "Mileage": "No Charge",
                "Print Fee": "$ 0.10 Per Page",
                "Admin Fee (%)": 13
            }
        ]
    }
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The court id field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The court id field is required.",
            "code": "1002"
        }
    }
}

New Order

POST {base_url} /placeOrder

The "Place Order" API is utilized to add a new user order to their Gouranger organization, utilizing unique card details if they don't already possess one. Users can create a maximum number of orders based on their requirements.

All newly added orders will be visible in the Gouranger account.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/placeOrder' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYxNDE1MywiZXhwIjoxNzAyNjE3NzUzLCJuYmYiOjE3MDI2MTQxNTMsImp0aSI6InIxZUt2SzdFQzloUVJLdEUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.Ax-gUGtxY4aGxpO_taTWpx9U6CS9BFhRRPqa_5n6DjU' \
	--form 'document_type[0]="1"' \
	--form 'case_name[0]="VSV, LLC vs. Sable Brown"' \
	--form 'case_number[0]="2384555LT"' \
	--form 'no_of_pages[0]="1"' \
	--form 'no_of_defendants[0]="2"' \
	--form 'no_of_miles[0]="1"' \
	--form 'instruction[0]="cancel/refund this, already uploaded in November"' \
	--form 'case_file1[0]=@"/C:/Users/DreamsTechnologies/Downloads/case_files.pdf"' \
	--form 'case_file1[1]=@"/C:/Users/DreamsTechnologies/Downloads/court_documents.pdf"' \
	--form 'document_type[1]="2"' \
	--form 'case_name[1]="CARLYLE PLACE V RUSSELL"' \
	--form 'case_number[1]="23-11313-LT"' \
	--form 'no_of_defendants[1]="1"' \
	--form 'no_of_pages[1]="1"' \
	--form 'no_of_miles[1]="1"' \
	--form 'instruction[1]=""' \
	--form 'card_id="card_1ONVmhAkZSJcydc6r7Py7Sis"' \
	--form 'case_file2[0]=@"/C:/Users/DreamsTechnologies/Downloads/order_invoice (1).pdf"' \
	--form 'case_file2[1]=@"/C:/Users/DreamsTechnologies/Downloads/order_invoice.pdf"'



	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/placeOrder',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'POST',
	  CURLOPT_POSTFIELDS => array('document_type[0]' => '1','case_name[0]' => 'VSV, LLC vs. Sable Brown','case_number[0]' => '2384555LT,'no_of_pages[0]' => '1','no_of_defendants[0]' => '2','no_of_miles[0]' => '1','instruction[0]' => 'cancel/refund this, already uploaded in November','case_file1[0]'=> new CURLFILE('/C:/Users/DreamsTechnologies/Downloads/case_files.pdf'),'case_file1[1]'=> new CURLFILE('/C:/Users/DreamsTechnologies/Downloads/court_documents.pdf'),'document_type[1]' => '2','case_name[1]' => 'CARLYLE PLACE V RUSSELL','case_number[1]' => '23-11313-LT','no_of_defendants[1]' => '1','no_of_pages[1]' => '1','no_of_miles[1]' => '1','instruction[1]' => '-','card_id' => 'card_1ONVmhAkZSJcydc6r7Py7Sis','case_file2[0]'=> new CURLFILE('/C:/Users/DreamsTechnologies/Downloads/order_invoice (1).pdf'),'case_file2[1]'=> new CURLFILE('/C:/Users/DreamsTechnologies/Downloads/order_invoice.pdf')),
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYxNDE1MywiZXhwIjoxNzAyNjE3NzUzLCJuYmYiOjE3MDI2MTQxNTMsImp0aSI6InIxZUt2SzdFQzloUVJLdEUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.Ax-gUGtxY4aGxpO_taTWpx9U6CS9BFhRRPqa_5n6DjU'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

We can add multiple cases in a single order by passing parameters with corresponding index values. Example: Case - 1 document_type[0], case_number[0], case_file1[0], case_file1[1] (Multiple documents can be added for a case). Example: Case - 2 document_type[1], case_number[1], case_file2[0], case_file2[1] (Multiple documents can be added for a case).

document_type
INTEGER REQUIRED

The document type of the case.

You can obtain the Document ID from the Get Document Details API.
case_name
STRING REQUIRED

The case name of the case.

Example: CARLYLE PLACE V RUSSELL
case_number
STRING REQUIRED

The case number of the case.

Example: 23-11313-LT
no_of_defendants
INTEGER OPTIONAL

Enter the total number of defendants to be served in this case.

Note: if your defendant count is inaccurate, you may incur additional service fees that must be paid before the process server will return a proof of service.

This will be required depending on the document type.
no_of_miles
INTEGER OPTIONAL

Enter the number of miles from the courthouse to the defendant's address.

Use a driving app like Google Maps to calculate mileage.

This will be required depending on the document type.
no_of_pages
INTEGER OPTIONAL

Enter the total number of pages of all documents attached to this case.

Note: if your page number is inaccurate, you may incur additional printing costs that must be paid before the process server will return proof of service.

This will be required depending on the document type.
instruction
STRING OPTIONAL

Enter any additional information that you believe the process server might need to find and serve Defendant as quickly as possible.
card_id
INTEGER REQUIRED

The card id of the attorney payment card.

You can obtain the Card ID from the Get Cards API .
case_file
FILES OPTIONAL

The customer documents of the case. Multiple documents can be added here with their corresponding index values.

This will be required depending on the document type.

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API adds a new order against the given document type with a success response.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Order Placed successfully",
    "data": {
        "Order ID": "496",
        "Order Payment": "$76.84",
        "Payment Date": "2023-11-28 07:26:16"
    }
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The case file field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The case file field is required.",
            "code": "1002"
        }
    }
}

Update Order

POST {base_url} /updateOrder

The "Update Order" API is used to update user orders, allowing modifications to order details such as adding customer documents.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/updateOrder' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYxNDE1MywiZXhwIjoxNzAyNjE3NzUzLCJuYmYiOjE3MDI2MTQxNTMsImp0aSI6InIxZUt2SzdFQzloUVJLdEUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.Ax-gUGtxY4aGxpO_taTWpx9U6CS9BFhRRPqa_5n6DjU' \
	--form 'case_id="3"' \
	--form 'case_number="23-11313-LT"' \
	--form 'case_name="warren manor vs jones"' \
	--form 'instruction="Thank you in advance for your time and consideration on this matter. Once service completed, please contact our office to arrange scheduling for the eviction itself where we will provide the Landlord'\''s contact information to you."' \
	--form 'case_file[0]=@"/C:/Users/DreamsTechnologies/Downloads/case_files.pdf"' \
	--form 'case_file[1]=@"/C:/Users/DreamsTechnologies/Downloads/court_documents.pdf"'



	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/updateOrder',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'POST',
	  CURLOPT_POSTFIELDS => array('case_id' => '3','case_number' => '23-11313-LT','case_name' => 'warren manor vs jones','instruction' => 'Thank you in advance for your time and consideration on this matter. Once service completed, please contact our office to arrange scheduling for the eviction itself where we will provide the Landlord\'s contact information to you.','case_file[0]'=> new CURLFILE('/C:/Users/DreamsTechnologies/Downloads/case_files.pdf'),'[case_file][1]'=> new CURLFILE('/C:/Users/DreamsTechnologies/Downloads/court_documents.pdf')),
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYxNDE1MywiZXhwIjoxNzAyNjE3NzUzLCJuYmYiOjE3MDI2MTQxNTMsImp0aSI6InIxZUt2SzdFQzloUVJLdEUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.Ax-gUGtxY4aGxpO_taTWpx9U6CS9BFhRRPqa_5n6DjU'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

case_id
INTEGER REQUIRED

The case id of the case.

You can obtain the Case ID from the Get Order List API.
court_id
INTEGER OPTIONAL

The court id of the user.

If the document type is "Miscellaneous Charges," then the court ID field is required.

You can obtain the Court ID from the Get Court Details API.
case_name
INTEGER OPTIONAL

The case name of the case.

Example: CARLYLE PLACE V RUSSELL
case_number
INTEGER OPTIONAL

The case number of the case.

Example: 23-11313-LT
instruction
INTEGER OPTIONAL

Enter any additional information that you believe the process server might need to find and serve Defendant as quickly as possible.
case_file
FILES OPTIONAL

The customer documents of the case. Multiple documents can be added here with their corresponding index values.

Example: [case_file][0] = "", [case_file][1] = "".

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API updates the corresponding user's case details with a success response.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Case Updated successfully.",
    "data": []
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The case id field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The case id field is required.",
            "code": "1002"
        }
    }
}

Get Order Summary

GET {base_url} /getOrderSummary/{order_id}

The "Get Order Summary" API is employed to retrieve the user order summary, including order and customer details from their Gouranger account based on the provided order details.

If the order ID is invalid, an error response is returned.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/getOrderSummary/9' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYxNDE1MywiZXhwIjoxNzAyNjE3NzUzLCJuYmYiOjE3MDI2MTQxNTMsImp0aSI6InIxZUt2SzdFQzloUVJLdEUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.Ax-gUGtxY4aGxpO_taTWpx9U6CS9BFhRRPqa_5n6DjU'




	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/getOrderSummary/9',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'GET',
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjYxNDE1MywiZXhwIjoxNzAyNjE3NzUzLCJuYmYiOjE3MDI2MTQxNTMsImp0aSI6InIxZUt2SzdFQzloUVJLdEUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.Ax-gUGtxY4aGxpO_taTWpx9U6CS9BFhRRPqa_5n6DjU'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

order_id
INTEGER REQUIRED

The order id of the order.

You can obtain the Order ID from the Get Order List API.

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API provides the order summary for the given order with a success response.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Order Summary Details Fetched Successfully",
    "data": {
        "Customer Info": {
            "Name": "Gabe Curtis",
            "Email": "rcurtis@robertjcurtislaw.com",
            "Contact Number": "(789) 765-5432",
            "Company Name": "Linnell & Associates",  
            "Address": "17557 Wayne Road",
            "Country": "United States",
            "State": "District of Columbia",
            "City": "Livonia",
            "Postal Code": "48152",
            "Court Name": "34th District Court",
            "Date of Order": "11/20/2023 05:16:19"
        },
        "Service Order Information": {
            "Case Details": [
                {
                    "Case ID": "35",
                    "Case Number": "23-10760 LT",
                    "Case Name": "Rivercrest Arms vs. Deajia Kaigler",
                    "Document Name": "Summons & Complaint General Civil (All Courts)",
                    "Pages Fee Type": "No of Pages: 1",
                    "Pages Price": "$ 0.10",
                    "Defendant Fee Type": "1 (Per Defendent Pricing)",
                    "Defendant Price": "$ 34.00",
                    "Mileage Fee Type": "No of Miles: 1",
                    "Mileage Price": "$ 0.98",
                    "Gouranger Fee (%)": 13,
                    "Gouranger Price": "$ 4.56",
                    "Comments": "-",
                    "Total Case Fee": "$ 39.63"
                }
            ]
        },
        "Grand Total": {
            "Order ID": "32"
            "Case Count": "1",
            "Grand Total": "$ 78.17"
        }
    }
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "Order does not Exists",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "Order does not Exists",
            "code": "1002"
        }
    }
}

Manage Order Details

The Manage Orders APIs are primarily designed to facilitate the management of user orders. This section demonstrates how to list, update, and remove order details.

Get Order List

GET {base_url} /getOrderList

The "Get Order List" API is used to list the logged-in user's orders with their corresponding court details.

All newly created orders will be visible in the list.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/getOrderList?court_id=1&keywords=&case_number=&date_range=&status=&server_assigned=&count_per_page=10&page=1' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'




	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/getOrderList?court_id=1&keywords=&case_number=&date_range=&status=&server_assigned=&count_per_page=10&page=1',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'GET',
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Code snippet - Referring to order search records

cURL
PHP


 curl --location 'https://www.gouranger.info/api/v1/getOrderList?court_id=1&case_number=23C05622LT&date_range=12%2F01%2F2023%20-%2012%2F31%2F2023&status=Inprogress&server_assigned=Robert%20Curtis&keywords=Robert&count_per_page=10&page=1' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwNTk5MTI2OCwiZXhwIjoxNzA1OTk0ODY4LCJuYmYiOjE3MDU5OTEyNjgsImp0aSI6IjJDZEVLelpUUmt1YkZwMkUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XvxdGJHRjyDsXD6aYbC4ihMgu-9JwHFzCR4onHqKSHM'




$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.gouranger.info/api/v1/getOrderList?court_id=1&case_number=23C05622LT&date_range=12%2F01%2F2023%20-%2012%2F31%2F2023&status=Inprogress&server_assigned=Robert%20Curtis&keywords=Robert&count_per_page=10&page=1',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwNTk5MTI2OCwiZXhwIjoxNzA1OTk0ODY4LCJuYmYiOjE3MDU5OTEyNjgsImp0aSI6IjJDZEVLelpUUmt1YkZwMkUiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XvxdGJHRjyDsXD6aYbC4ihMgu-9JwHFzCR4onHqKSHM'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

court_id
INTEGER REQUIRED

The court id of the user.

You can obtain the Court ID from the Get Court Details API.
case_number
STRING OPTIONAL

The case number for searching in orders.

Example: 23-11313-LT
status
STRING OPTIONAL

The case status for searching in orders.

The available status options are New, Inprogress, and Completed.

Example: Inprogress
server_assigned
STRING OPTIONAL

The assigned process server name for searching in orders.

You can enter the Process Server name for searching in orders.

Example: Robert Curtis
date_range
STRING OPTIONAL

The order date range for searching orders.

Example: 09/20/2023 - 09/26/2023
keywords
STRING OPTIONAL

The keywords for searching in orders.

It will display the matched records with the Case Name, Case Number and Server Assigned.

Example: Highland Greens v Zion
count_per_page
INTEGER OPTIONAL

The required count per page for pagination.

Example: 10
page
INTEGER OPTIONAL

Required page number to display from the list.

Example: 2

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API sends a success response with the corresponding user's order details.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Orders List fetched successfully",
    "data": {
        "Result": {
            "Total Count": "24",
            "Last Page": "3",
            "Current Page": "1"
        },
        "List": [
            {
                "Case ID":34,
                "Order ID": 37,
                "Order Date": "11/22/2023 17:24:48",
                "Case Status": "New",
                "Case Number": "23-1234-LT",
                "Case Name": "jones v. smith",	
                "Proof Of Service": "",
                "Receipt Url": "https://www.gouranger.info/api/v1/getOrderReceipt/2/37",
                "Server Assigned": "Robert Curtis (589) 766-5532"
                "Payment Status": "Paid Credit Card",
                "Customer Document": "https://livedatabucketgouranger.s3.us-east-2.amazonaws.com/case_files/11_22_2023_172448pm1702412321435_FileStampedCopy%20-%202023-12-12T131109.477JFDANIELS%20S",
            }
        ]
    }
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The court id field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The court id field is required.",
            "code": "1002"
        }
    }
}

Example Responses for Order Search Records

If the Bearer Token is valid and matches the logged-in user, the API sends a success response with the corresponding user's order details.

If the token is incorrect, an unauthorized response is generated.


	{
		"code": "200",
		"message": "Orders List fetched successfully",
		"data": {
			"Result": {
				"Total Count": "1",
				"Last Page": "1",
				"Current Page": "1"
			},
			"List": [
				{
					"Case ID":39,
					"Order ID": 30,
					"Order Date": "12/22/2023 17:24:48",
					"Case Status": "In Progress",
					"Case Number": "23C05622LT",
					"Case Name": "Highland Greens v Zion",	
					"Proof Of Service": "",
					"Receipt Url": "https://www.gouranger.info/api/v1/getOrderReceipt/2/30",
					"Server Assigned": "Robert Curtis (589) 766-5532"
					"Payment Status": "Paid Credit Card",
					"Customer Document": "https://livedatabucketgouranger.s3.us-east-2.amazonaws.com/case_files/12_22_2023_172448pm1702412321435_FileStampedCopy%20-%202023-12-12T131109.477JFDANIELS%20S",
				}
			]
		}
	}


	{
		"code": "401",
		"message": "Unauthorized request",
		"data": {
			"error": {
				"user_message": "Unauthorized request",
				"internal_message": "User Unauthorised",
				"code": "1001"
			}
		}
	}


	{
		"code": "400",
		"message": "The court id field is required.",
		"data": {
			"error": {
				"user_message": "Required parameters need to be filled and it must be valid.",
				"internal_message": "The court id field is required.",
				"code": "1002"
			}
		}
	}

Get Outstanding Order List

GET {base_url} /getOutstandingOrderList

The "Get Outstanding Order List" API is used to obtain the outstanding payment order list corresponding to their court details.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/getOutstandingOrderList?keywords=&court_id=1&count_per_page=10&page=' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'



	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info:8000/api/v1/getOutstandingOrderList?keywords=&court_id=1&count_per_page=10&page=',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'GET',
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Authorization Header

To authenticate, add an Authorization header to your API request that contains an Bearer Token. API requests without authentication will also fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

court_id
INTEGER REQUIRED

The court id of the user.

You can obtain the Court ID from the Get Court Details API.
keywords
STRING OPTIONAL

The keywords for searching in orders.

It will display the matched records with the Case Name and Number.
count_per_page
INTEGER OPTIONAL

The required count per page for pagination.

Example: 10
page
INTEGER OPTIONAL

Required page number to display from the list.

Example: 2

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API sends a success response with the corresponding user's outstanding order details.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Outstanding Order List fetched successfully",
    "data": {
        "Result": {
            "Total Count": "1",
            "Last Page": "1",
            "Current Page": "1"
        },
        "List": [
            {
                "Order ID": 36,
                "Order Date": "11/22/2023 19:24:48",
                "Case Number": "23-10760 LT",
                "Case Name": "Rivercrest Arms vs. Deajia Kaigler",
                "Case Status": "New",
                "Receipt Url": "https://www.gouranger.info/api/v1/getOrderReceipt/2/37",
                "Payment Status": "Pending",
                "Customer Document": "https://livedatabucketgouranger.s3.us-east-2.amazonaws.com/case_files/11_22_2023_192448pm1702412321395_FileStampedCopy%20-%202023-12-12T131130.017%20JFDANIELS%20C",
                "Server Assigned": "Robert Curtis (589) 766-5532"
            }
        ]
    }
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The court id field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The court id field is required.",
            "code": "1002"
        }
    }
}

Complete Order Payment

POST {base_url} /completePayment

The "Complete Order Payment" API is used to allow the user to complete outstanding payments in their Gouranger account.

Code snippet

cURL
PHP


curl --location 'https://www.gouranger.info/api/v1/completePayment' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDExNTYyMDAsImV4cCI6MTcwMTE1OTgwMCwibmJmIjoxNzAxMTU2MjAwLCJqdGkiOiJOakFXVndOTGtqcmlaSkxwIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.OcAZvY0y8AqlRzugYvw1jtI9ixR-RUBGG3tzV-EJSu4' \
--form 'card_id="card_1OHLg0AkZSJcydc6djn2Mau8"' \
--form 'order_id="495"'



$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://www.gouranger.info/api/v1/completePayment',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('card_id' => 'card_1OHLg0AkZSJcydc6djn2Mau8','order_id' => '495'),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDExNTYyMDAsImV4cCI6MTcwMTE1OTgwMCwibmJmIjoxNzAxMTU2MjAwLCJqdGkiOiJOakFXVndOTGtqcmlaSkxwIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.OcAZvY0y8AqlRzugYvw1jtI9ixR-RUBGG3tzV-EJSu4'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

order_id
INTEGER REQUIRED

The order id of the order.

You can obtain the Order ID from the Get Order List API.
card_id
INTEGER REQUIRED

The card id of the user.

You can obtain the Card ID from the Get Cards API .

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API completes the outstanding order payment with a success response.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Payment made Sucessfully",
    "data": {
        "Order ID": "495",
        "Order Payment": "$18.45",
        "Payment Date": "2023-11-28 07:45:01"
    }
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The card id field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The card id field is required.",
            "code": "1002"
        }
    }
}

Delete Customer Document

DELETE {base_url} /deleteCustomerDocument

The "Delete Customer Document" API is used to delete the customer documents of the corresponding case details.

If the document ID is invalid, an error response is returned.

Code snippet

cURL
PHP


curl --location --request DELETE 'https://www.gouranger.info/api/v1/deleteCustomerDocument?document_id=4' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'




	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/deleteCustomerDocument?document_id=4',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'DELETE',
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

document_id
INTEGER REQUIRED

The document id of the case.

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API removes the customer document of the corresponding case details with a success response.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Customer Document Deleted Successfully",
    "data": []
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The selected document id is invalid.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The selected document id is invalid.",
            "code": "1002"
        }
    }
}

Delete Case Details

DELETE {base_url} /deleteCase

The "Delete Case" API is used to delete the case details of the corresponding logged-in user with their case ID.

If the case ID is invalid, an error response is returned.

Code snippet

cURL
PHP


curl --location --request DELETE 'https://www.gouranger.info/api/v1/deleteCase?case_id=2' \
	--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'




	$curl = curl_init();
	
	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'https://www.gouranger.info/api/v1/deleteCase?case_id=2',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'DELETE',
	  CURLOPT_HTTPHEADER => array(
		'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9nb3VyYW5nZXIuY29tOjgwMDBcL2FwaVwvdjFcL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTcwMjQ0MjA1NSwiZXhwIjoxNzAyNDQ1NjU1LCJuYmYiOjE3MDI0NDIwNTUsImp0aSI6IjZOUXdXckJIUFNBYzh1WkIiLCJzdWIiOjEsInBydiI6ImE3MDU2ZTI1NjljNTQzZjc2YTg5MDY1YWU3ODRlZTUwODkzMjlmZWYifQ.XK3eNZCKsKT54_EATqFyt5ltK4b6VH-y2jjB25CeMzI'
	  ),
	));
	
	$response = curl_exec($curl);
	
	curl_close($curl);
	echo $response;

Authorization Header

To authenticate, include an Authorization header in your API request containing a Bearer Token. API requests without authentication will fail.

Authenticate with bearer token,

Bearer Token

#--for a cross-origin request, use -H "Authorization: 
												

--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvd3d3LmdvdXJhbmdlci5pbmZvXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE3MDEwMTkyNjQsImV4cCI6MTcwMTAyMjg2NCwibmJmIjoxNzAxMDE5MjY0LCJqdGkiOiJVczhzM1VRZTA1NzZ1RGdnIiwic3ViIjoxLCJwcnYiOiJhNzA1NmUyNTY5YzU0M2Y3NmE4OTA2NWFlNzg0ZWU1MDg5MzI5ZmVmIn0.VS3ET7IJSOpFcLZShIqXTIzLvhuiBxiJLaF2sOz4Jrs'

Request body

case_id
INTEGER REQUIRED

The case id of the order.

You can obtain the Case ID from the Get Order List API.

Example Responses

If the Bearer Token is valid and matches the logged-in user, the API removes the corresponding user's case details with a success response.

If the token is incorrect, an unauthorized response is generated.


{
    "code": "200",
    "message": "Case details deleted sucessfully",
    "data": []
}


{
    "code": "401",
    "message": "Unauthorized request",
    "data": {
        "error": {
            "user_message": "Unauthorized request",
            "internal_message": "User Unauthorised",
            "code": "1001"
        }
    }
}


{
    "code": "400",
    "message": "The case id field is required.",
    "data": {
        "error": {
            "user_message": "Required parameters need to be filled and it must be valid.",
            "internal_message": "The case id field is required.",
            "code": "1002"
        }
    }
}