Book a Demo
Book a Demo

API Documentation

api.scoremachine.ai

Introduction

The api.scoremachine.ai API provides fast, secure, and real-time validation of phone numbers and emails.

It is designed to integrate seamlessly into any technology stack, making it ideal for businesses of all sizes.

The API offers detailed information about phone numbers, including carrier details, location, and more. For a full list of features, visit our project website https://scoremachine.ai/

Base URL, Authentication, Methods

  • Base URL: https://api.scoremachine.ai/
  • Authentication: Requests are authenticated using a client token
  • Supported HTTP Methods: POST, GET

Conventions

Data Format JSON
Encoding UTF-8
HTTP Methods GET, POST
Field Naming Convention snake_case

Errors and HTTP Status Codes

Successful Request 200 OK
Validation Error 422 Validation Error
Invalid Parameters 400 Bad Request
Missing Authentication 401 Unauthorized
Resource Not Found 404 Not Found
Server Error 500 Internal Server Error


Endpoints

scoring POST /validation

URL: https://api.scoremachine.ai/validation

HTTP Method: POST

Description:

This method validates a single `phone` number and retrieves additional information about it. You can specify which checks to perform by setting the appropriate parameters in the request body. Parameters `POST` /validation:

Parameters:
phone string The `phone` number to validate
normalization boolean Set to `true` to normalize the `phone` number into various formats
Example:
"international_format": "+0 000 000-00-00",
"local_format": "0 (000) 000-00-00",
"e164_format": "+00000000000",
tg boolean Set to `true` to check if a TG account is linked to the `phone` number
wa boolean Set to `true` to check if a WA account is linked to the `phone` number
validation boolean Set to `true` to retrieve detailed information about the `phone` number
Example: 
{
    "prefixer": {
        "carrier": "Carrier_name",
        "carrier_full": "Carrier_full_name",
        "location": "Location",
        "timezone": "UTC+0",
        "country": "Country",
        "line_type": "mobile",
        "iso_code": "XX"
    }
}
Example Request POST /validation
curl -X 'POST' \
'http://api.scoremachine.ai/validation' \
-H 'accept: application/json' \
-H 'token: your_token' \
-H 'Content-Type: application/json' \
-d '{
"phone": "00000000000",
"normalization": true,
"tg": false,
"wa": false,
"validation": false
}'
Example Response POST /validation
{
    "phone": "00000000000",
    "normalized_phone": "00000000000",
    "normalization": {
        "international_format": "+0 000 000-00-00",
        "local_format": "0 (000) 000-00-00",
        "e164_format": "+00000000000"
    },
    "validation_time": "yyyy-mm-dd hh:mm:ss"
}
Response Fields `POST` /validation endpoint contains:
phone string The `phone` number provided in the request
normalized_phone string Returns only the digits from the provided `phone` for normalization and database lookup
normalization dictionary Contains the normalized formats of the `phone` number
Example: 
"normalization": {
    "international_format": "+0 000 000-00-00",
    "local_format": "0 (000) 000-00-00",
    "e164_format": "+00000000000"
},
validation_time date-time The timestamp of when the request was processed, in `yyyy-mm-dd hh:mm:ss` format
Possible Errors POST /validation
401 recaptcha invalid Occurs when the `recaptcha-token` is missing or invalid
Example: 
{ "details": "Invalid reCAPTCHA verification",
    "status_code": 401 }
401 token invalid Occurs when the system `token` is missing or invalid
Example: 
{ "details": "Missing or invalid Authorization header",
    "status_code": 401 }
400 low balance Occurs when the account balance is zero or negative
Example: 
{ "detail": "Low balance",
    "status_code": 400 }


POST /validation/batch

URL: https://api.scoremachine.ai/validation/batch

HTTP Method: POST

Description:

This method validates multiple `phones` numbers in a single request. After submitting the request, you will receive a task `id` that you can use to check the status and results of the batch validation. Parameters `POST` /validation/batch:

Parameters:
phones list A list of `phones` numbers to validate
normalization boolean Set to `true` to normalize the `phones` numbers into various formats
Example:
"international_format": "+0 000 000-00-00",
"local_format": "0 (000) 000-00-00",
"e164_format": "+00000000000",
tg boolean Set to `true` to check if TG accounts are linked to the `phones` numbers
wa boolean Set to `true` to check if WA accounts are linked to the `phones` numbers
validation boolean Set to `true` to retrieve detailed information about the `phones` numbers
Example: 
"prefixer": {
    "carrier": "Carrier_name",
    "carrier_full": "Carrier_full_name",
    "location": "Location",
    "timezone": "UTC+0",
    "country": "Country",
    "line_type": "mobile",
    "iso_code": "XX"
},
Example Request:
curl -X 'POST' \
'http://api.scoremachine.ai/validation/batch' \
-H 'accept: application/json' \
-H 'token: your_token' \
-H 'Content-Type: application/json' \
-d '{
"phones": [
    "00000000000",
    "00000000000",
    "00000000000"
],
"normalization": true,
"tg": true,
"wa": true,
"validation": true
}'
Example Response POST /validation/batch
"000xx0x0-00x0-0xxx-00x0-0xxx000xx000"
Response Field `POST` /validation/batch endpoint contains:
id string The task `id` generated for the batch validation
Possible Errors POST /validation/batch
401 token invalid Occurs when the system `token` is missing or invalid
Example: 
{ "details": "Missing or invalid Authorization header",
"status_code": 401 }
400 low balance Occurs when the account balance is zero or negative
Example: 
{ "detail": "Low balance",
"status_code": 400 }


POST /validation/email

URL: https://api.scoremachine.ai/validation/email

HTTP Method: POST

Description:

This method validates a single `email` address and retrieves additional information about it. In the request, a JSON object is sent containing the `email` field with the email address to be validated. Example:

{ "email": "[email protected]" }
Parameters for `POST` /validation/email:
email string The `email` address to validate
Example Request POST /validation/email
curl -X 'POST' \
'http://api.scoremachine.ai/validation/email' \
-H 'accept: application/json' \
-H 'token: your_token' \
-H 'Content-Type: application/json' \
-d '{
"email": "[email protected]"
}'
Example Response POST /validation/email
{
    "email": "[email protected]",
    "valid": true,
    "probable_name": "User Name",
    "profile_photo": "https://xx0.googleusercontent.com/x-/XXX-XxX0Xx0X-x0",
    "last_update": "yyyy-mm-dd hh:mm:ss",
    "probable_country": null,
    "country_code": null,
    "provider": "gmail-smtp-in.l.google.com",
    "validation_time": "yyyy-mm-dd hh:mm:ss"
}
Response Fields `POST` /validation/email endpoint contains
email string The `email` address provided in the request
valid boolean A value of `true` indicates that the email is valid. If the email is invalid, the value will be `false`, and all other fields will return `null`
probable_name string The probable name associated with the email.
Available only for Google accounts (both personal and business), returns `null` for other emails
profile_photo string A link to the profile photo of the Google account
Available only for Google accounts, returns `null` for other emails.
last_update date-time The timestamp of the last account update in `yyyy-mm-dd hh:mm:ss` format.
Available only for Google accounts, returns `null` for other emails.
probable_country string The probable country associated with the email.
Available only for Google accounts, returns `null` for other emails.
country_code string The two-letter country code in Alpha-2 ISO 3166-1 format.
Available only for Google accounts, returns `null` for other emails.
provider string The SMTP domain of the email provider
validation_time date-time The timestamp of when the validation was performed, in `yyyy-mm-dd hh:mm:ss` format.
Possible Errors POST /validation/email
401 recaptcha invalid Occurs when the `recaptcha-token` is missing or invalid
Example: 
{ "details": "Invalid reCAPTCHA verification",
"status_code": 401 }
401 token invalid Occurs when the system `token` is missing or invalid
Example: 
{ "details": "Missing or invalid Authorization header",
"status_code": 401 }
400 low balance Occurs when the account balance is zero or negative
Example: 
{ "detail": "Low balance",
"status_code": 400 }


GET /task/{id}

URL: https://api.scoremachine.ai/task/{id}

HTTP Method: GET

Description:

This method retrieves the results of a batch validation task using the task `id` returned by the `POST` /validation/batch endpoint:

Parameters:
id string task `id`
Example Request GET /task/{id}
curl -X 'GET' \
'http://api.scoremachine.ai/task/000xx0x0-00x0-0xxx-00x0-0xxx000xx000' \
-H 'accept: application/json' \
-H 'token: your_token'
Example Response GET /task/{id}
{
    "task_id": "000xx0x0-00x0-0xxx-00x0-0xxx000xx000",
    "task_status": "SUCCESS",
    "task_result": {
        "00000000000": {
            "valid": true,
            "normalized_phone": "00000000000",
            "tg": false
        },
        "00000000000": {
            "valid": true,
            "normalized_phone": "00000000000",
            "tg": false
        },
        "00000000000": {
            "valid": true,
            "normalized_phone": "00000000000",
            "tg": false
        }
    }
}
Response Fields `GET` /task/{id} endpoint contains:
task_id string The task `id`
task_status string The status of the `task_status`. Possible values:
`PENDING` : The task is waiting to be processed
`STARTED` : The task is currently being processed
`SUCCESS` : The task has been successfully completed
`FAILURE` : An error occurred while processing the task
`RETRY` : The task has been queued for retry after a failure
`REVOKED` : The task was canceled before or during execution
task_result dictionary The results of the `task_result` in JSON format
Possible Errors GET /task/{id}
401 token invalid Occurs when the system `token` is missing or invalid
Example: 
{ "details": "Missing or invalid Authorization header",
"status_code": 401 }


GET /user/get-balance

URL: https://api.scoremachine.ai/user/get-balance

HTTP Method: GET

Description:

This method retrieves the current balance of the authenticated user. No parameters are required, as the method provides balance information for the currently authorized user.

Example Request GET /user/get-balance
curl -X 'GET' \
'http://api.scoremachine.ai/user/get-balance' \
-H 'accept: application/json' \
-H 'token: your_token'
Example Response GET /user/get-balance
{ "balance": 100500 }
Response Fields `GET` /user/get-balance endpoint contains
balance float The amount of funds available in the user's account
Possible Errors GET /user/get-balance
401 token invalid Occurs when the system `token` is missing or invalid
Example: 
{ "details": "Missing or invalid Authorization header",
"status_code": 401 }


GET /user/get-transactions

URL: https://api.scoremachine.ai/user/get-transactions

HTTP Method: GET

Description:

This method retrieves a list of transactions showing deductions from the balance of the authenticated user. No parameters are required, as the method provides transaction history for the currently authorized user.

Example Request GET /user/get-transactions
curl -X 'GET' \
'http://api.scoremachine.ai/user/get-transactions' \
-H 'accept: application/json' \
-H 'token: your_token'
Example Response GET /user/get-transactions
{
    "items": [
        {
            "timestamp": "YYYY-MM-DD HH:MM:SS",
            "amount": -0.0,
            "comment": "Score machine validation - batch - count of phones: 3, task id: None"
        },
        {
            "timestamp": "YYYY-MM-DD HH:MM:SS",
            "amount": -0.0,
            "comment": "Score machine validation - phone: 00000000000"
        }
    ],
    "total": 0
}
Response Fields `GET` /user/get-transactions endpoint contains
items array [{}] A list of dictionaries containing transaction details for the authenticated user. Each item includes:
`timestamp` (string) : the date and time when the transaction occurred, in YYYY-MM-DD HH:MM:SS format.
`amount` (float) : the amount deducted in the transaction.
`comment` (string) : a description of the transaction.
total int The `total` (integer) number of transactions returned in the response.
Possible Errors GET /user/get-transactions
401 token invalid Occurs when the system `token` is missing or invalid
Example: 
{ "details": "Missing or invalid Authorization header",
"status_code": 401 }


Contacts

For questions about implementing or using api.scoremachine.ai feel free to reach out to us:

Technical Support & Commercial Inquiries [email protected]

Website https://scoremachine.ai/

Book a Demo

Fill out the feedback form
and our specialist will contact you as soon as possible.




Switch to JSON View



          

        

      

    

    

      

      
 
        

          

          

            

              
Terms and Conditions of Use 

              

                
Last Updated: January 31, 2025

                
1. Company Information

                
ScoreMachine is a service provided by:
BOTTO PLATFORM - FZCO (dba “ScoreMachine.ai”)
License No: 27443 
Dubai Silicon Oasis, DDP, Building A1 
Dubai, United Arab Emirates

                
2. Agreement to Terms

                
By accessing or using ScoreMachine's services ("Services"), you agree to be bound by these Terms and Conditions ("Terms"). If you disagree with any part of these Terms, you do not have permission to access the Services.

                
3. Service Description

                
ScoreMachine provides phone number validation, scoring, and verification services. The Services include, but are not limited to, phone number validation, carrier detection, geolocation, and messaging platform detection.

                
4. Use Restrictions

                
You agree not to use the Services:
a) For any unlawful purpose or to solicit the performance of any illegal activity
b) To harass, abuse, stalk, or threaten others
c) To send spam, unsolicited bulk messages, or automated messaging
d) To collect or harvest phone numbers or personal information without proper consent
e) To circumvent or manipulate usage limitations or pricing
f) In violation of any applicable laws, regulations, or third-party rights

                
5. Data Usage and Privacy

                
5.1 Data Processing

                
You warrant that you have all necessary rights, consents, and permissions to process the phone numbers and related data through our Services.

                
5.2 Compliance

                
You are solely responsible for ensuring your use of the Services complies with all applicable privacy laws, including but not limited to GDPR, CCPA, and TCPA.

                
6. Disclaimer of Warranties

                
THE SERVICES ARE PROVIDED "AS IS" AND "AS AVAILABLE" WITHOUT ANY WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED. ScoreMachine DOES NOT WARRANT THAT:
a) The Services will be uninterrupted, error-free, or completely secure
b) The validation results will be 100% accurate or up-to-date
c) The Services will meet your specific requirements
d) Any errors in the Services will be corrected

                
7. Limitation of Liability

                
7.1 Direct Damages

                
IN NO EVENT SHALL ScoreMachine BE LIABLE FOR ANY DIRECT DAMAGES EXCEEDING THE AMOUNT PAID BY YOU FOR THE SERVICES DURING THE THREE (3) MONTHS PRECEDING THE INCIDENT.

                
7.2 Indirect Damages

                
ScoreMachine SHALL NOT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO:
a) Loss of profits, revenue, or data
b) Business interruption
c) Cost of procurement of substitute services
d) Any damages resulting from your use or inability to use the Services

                
8. Indemnification

                
You agree to indemnify, defend, and hold harmless ScoreMachine and its officers, directors, employees, agents, and affiliates from and against any claims, liabilities, damages, losses, costs, or expenses arising from:
a) Your violation of these Terms
b) Your use of the Services
c) Your violation of any applicable laws or regulations
d) Your violation of any third-party rights

                
9. Service Modifications

                
ScoreMachine reserves the right to:
a) Modify or discontinue any part of the Services
b) Change the pricing of the Services
c) Update these Terms at any time
d) Limit or restrict access to the Services

                
10. Termination

                
10.1 Termination by User

                
You may terminate your use of the Services at any time by discontinuing use and canceling any active subscriptions.

                
10.2 Termination by ScoreMachine

                
ScoreMachine may terminate or suspend your access to the Services immediately, without prior notice, for:
a) Violation of these Terms
b) Suspected fraudulent, abusive, or illegal activity
c) Non-payment of fees
d) Any other reason deemed appropriate by ScoreMachine

                
11. Governing Law

                
These Terms shall be governed by and construed in accordance with the laws of Dubai, United Arab Emirates, without regard to its conflict of law provisions. Any disputes arising under or in connection with these Terms shall be subject to the exclusive jurisdiction of the courts of Dubai, United Arab Emirates.

                
12. Severability
If any provision of these Terms is found to be unenforceable or invalid, that provision shall be limited or eliminated to the minimum extent necessary while preserving the remaining provisions.

                
13. Contact Information

                
For questions about these Terms, please contact us at [email protected]

                
14. Changes to Terms

                
ScoreMachine reserves the right to modify these Terms at any time. We will notify users of any material changes via email or through the Services. Your continued use of the Services after such modifications constitutes acceptance of the updated Terms.

              

            

            

              
Privacy Policy

              
   
                
p.right Last Updated: January 31, 2025

                
p 1. Company Information 
ScoreMachine is a service provided by:
 BOTTO PLATFORM - FZCO (dba “ScoreMachine.ai”) 
 License No: 27443 
 Dubai Silicon Oasis, DDP, Building A1 
Dubai, United Arab Emirates

                
2. Introduction

                
This Privacy Policy explains how ScoreMachine ("we," "us," or "our") collects, uses, discloses, and safeguards information when you use our phone number validation and scoring services. We are committed to protecting your privacy and handling any personal information we obtain with care and respect.

                
3. Information We Collect

                
3.1 Information You Provide

                
- Account information (name, email address, company details)
 - Billing information 
- Phone numbers and related data submitted for validation 
- Communication preferences 
- Customer service communications

                
3.2 Information Automatically Collected

                
- Log data (IP address, browser type, pages visited)
- Device information 
- Usage data 
- Cookies and similar tracking technologies

                
4. How We Use Your Information

                
We use the collected information for the following purposes: 
- Providing and maintaining our Services 
- Processing and validating phone numbers 
- Sending service updates and administrative messages 
- Billing and account management 
- Improving and optimizing our Services 
- Detecting and preventing fraud 
- Complying with legal obligations

                
5 Data Processing

                
5.1 Phone Number Processing

                
When you submit phone numbers for validation, we: 
- Process the data only as necessary to provide our Services 
- Do not store phone numbers longer than necessary for service delivery 
- Do not use submitted phone numbers for any purpose other than validation and scoring

                
5.2 Data Retention

                
We retain your information only for as long as necessary to: 
- Provide our Services 
- Comply with legal obligations 
- Resolve disputes 
- Enforce our agreements

                
6. Information Sharing

                
We may share your information with:

                
6.1 Service Providers

                
Third-party vendors who assist us in providing our Services, subject to confidentiality agreements.

                
6.2 Legal Requirements

                
When required by law or to: 
- Comply with legal process 
- Protect our rights and property 
- Prevent fraud or abuse 
- Ensure the safety of our users

                
7. Data Security

                
We implement appropriate technical and organizational measures to protect your information, including: 
- Encryption of data in transit and at rest 
- Access controls 
- Regular security assessments 
- Employee training on data protection

                
8. International Data Transfers

                
We may transfer your information to countries other than where you reside. When we do, we ensure appropriate safeguards are in place to protect your information.

                
9. Your Rights

                
Depending on your location, you may have the right to: 
- Access your personal information 
- Correct inaccurate data 
- Request deletion of your data 
- Object to processing 
- Data portability 
- Withdraw consent

                
10. Children's Privacy

                
Our Services are not directed to children under 16. We do not knowingly collect personal information from children under 16.

                
11. Cookie Policy

                
We use cookies and similar tracking technologies to: 
- Maintain your preferences 
- Analyze usage patterns 
- Enhance site functionality 
- Improve user experience

                
You can control cookie preferences through your browser settings.

                
12. Third-Party Links

                
Our Services may contain links to third-party websites. We are not responsible for their privacy practices.

                
13. Changes to This Policy

                
We may update this Privacy Policy periodically. We will notify you of any material changes by: 
- Posting the new policy on our website 
- Sending you an email notification 
- Displaying a notice in your account

                
14. GDPR Compliance

                
For users in the European Economic Area (EEA): 
- We process personal data lawfully, fairly, and transparently 
- We collect data for specified, explicit, and legitimate purposes 
- We ensure data minimization and accuracy 
- We implement appropriate security measures 
- We respect data subject rights under GDPR

                
15. Contact Us

                
For privacy-related inquiries or to exercise your rights, contact us at: 
Email: [email protected]

                
Address:  
BOTTO PLATFORM - FZCO  
Dubai Silicon Oasis, DDP, Building A1  
Dubai, United Arab Emirates

              

            

          

        

      

    

    

      

      
 
        

          

          

            

              

                
API Documentation

                

                  
Table of Contents

                  
                  

                    
Introduction

                    
The api.scoremachine.ai API provides fast, secure, and real-time validation of phone numbers.

                    
It is designed to integrate seamlessly into any technology stack, making it ideal for businesses of all sizes.

                    
The API offers detailed information about phone numbers, including carrier details, location, and more. For a full list of features, visit our project website https://scoremachine.ai/

                  

                  

                    
Base URL, Authentication, Methods

                    
strong Base URL: https://api.scoremachine.ai/

                    
 Authentication: Requests are authenticated using a client token

                    
strong Supported HTTP Methods: POST, GET

                  

                  

                    
Conventions

                    

                      

                        Data Format
                        JSON
                      

                      

                        Encoding
                        UTF-8
                      

                      

                        HTTP Methods
                        GET, POST
                      

                      

                        Field Naming Convention
                        snake_case
                      

                    

                  

                  

                    
Errors and HTTP Status Codes

                    

                      

                        Successful Request
                        200 OK
                      

                      

                        Validation Error
                        422 Validation Error
                      

                      

                        Invalid Parameters
                        400 Bad Request
                      

                      

                        Missing Authentication
                        401 Unauthorized
                      

                      

                        Resource Not Found
                        404 Not Found
                      

                      

                        Server Error
                        500 Internal Server Error
                      

                    

                  

                  

                    
Endpoints

                    
scoring

                    
POST /validation

                    
URL: https://api.scoremachine.ai/validation

                    
HTTP Method: POST

                    
Description: This method validates a single phone number and retrieves additional information about it. You can specify which checks to perform by setting the appropriate parameters in the request body.

                    
Parameters:

                    

                      

                        Parameter
                        Type
                        Description
                      

                      

                        phone
                        string
                        The phone number to validate
                      

                      

                        normalization
                        boolean
                        Set to true to normalize the phone number into various formats
                      

                      

                        tg
                        boolean
                        Set to true to check if a TG account is linked to the phone number
                      

                      

                        wa
                        boolean
                        Set to true to check if a WA account is linked to the phone number
                      

                      

                        validation
                        boolean
                        Set to true to retrieve detailed information about the phone number
                      

                      

                        scoring
                        boolean
                        This feature is under development. Setting this to true will return "coming soon"
                      

                    

                    
Example Request:

                    
curl -X 'POST' \
'http://api.scoremachine.ai/validation' \
-H 'accept: application/json' \
-H 'token: your_token' \
-H 'Content-Type: application/json' \
-d '{
"phone": "00000000000",
"normalization": true,
"tg": false,
"wa": false,
"validation": false,
"scoring": true
}'

                    
Example Response:

                    
{
"phone": "00000000000",
"scoring": "coming soon",
"normalized_phone": "00000000000",
"normalization": {
    "international_format": "+0 000 000-00-00",
    "local_format": "0 (000) 000-00-00",
    "e164_format": "+00000000000"
},
"validation_time": "yyyy-mm-dd hh:mm:ss"
}

                    
Response Fields:

                    

                      

                        Field
                        Type
                        Description
                      

                      

                        phone
                        string
                        The phone number provided in the request
                      

                      

                        scoring
                        string
                        Returns "coming soon" if scoring is set to true
                      

                      

                        normalized_phone
                        string
                        Returns only the digits from the provided phone for normalization and database lookup
                      

                      

                        normalization
                        dictionary
                        Contains the normalized formats of the phone number
                      

                      

                        validation_time
                        date-time
                        The timestamp of when the request was processed, in yyyy-mm-dd hh:mm:ss format
                      

                    

                    
Possible Errors:

                    

                      

                        Error Code
                        Error
                        Description
                      

                      

                        401
                        recaptcha invalid
                        Occurs when the recaptcha-token is missing or invalid
                      

                      

                        401
                        token invalid
                        Occurs when the system token is missing or invalid
                      

                      

                        400
                        low balance
                        Occurs when the account balance is zero or negative
                      

                    

                  

                  

                    
POST /validation/batch

                    
URL: https://api.scoremachine.ai/validation/batch

                    
HTTP Method: POST

                    
Description: This method validates multiple phones numbers in a single request. After submitting the request, you will receive a task id that you can use to check the status and results of the batch validation.

                    
Parameters:

                    

                      

                        Parameter
                        Type
                        Description
                      

                      

                        phones
                        list
                        A list of phones numbers to validate
                      

                      

                        normalization
                        boolean
                        Set to true to normalize the phones numbers into various formats
                      

                      

                        tg
                        boolean
                        Set to true to check if TG accounts are linked to the phones numbers
                      

                      

                        wa
                        boolean
                        Set to true to check if WA accounts are linked to the phones numbers
                      

                      

                        validation
                        boolean
                        Set to true to retrieve detailed information about the phones numbers
                      

                      

                        scoring
                        boolean
                        This feature is under development. Setting this to true will return "coming soon"
                      

                    

                    
Example Request:

                    
curl -X 'POST' \
'http://api.scoremachine.ai/validation/batch' \
-H 'accept: application/json' \
-H 'token: your_token' \
-H 'Content-Type: application/json' \
-d '{
"phones": [
    "00000000000",
    "00000000000",
    "00000000000"
],
"normalization": true,
"tg": true,
"wa": true,
"validation": true,
"scoring": true
}'

                    
Example Response:

                    
"000xx0x0-00x0-0xxx-00x0-0xxx000xx000"

                    
Response Field:

                    

                      

                        Field
                        Type
                        Description
                      

                      

                        id
                        string
                        The task id generated for the batch validation
                      

                    

                    
Possible Errors:

                    

                      

                        Error Code
                        Error
                        Description
                      

                      

                        401
                        token invalid
                        Occurs when the system token is missing or invalid
                      

                      

                        400
                        low balance
                        Occurs when the account balance is zero or negative
                      

                    

                  

                  

                    
GET /task/{id}

                    
URL: https://api.scoremachine.ai/task/{id}

                    
HTTP Method: GET

                    
Description: This method retrieves the results of a batch validation task using the task id returned by the POST /validation/batch endpoint.

                    
Parameters:

                    

                      

                        Parameter
                        Type
                        Description
                      

                      

                        id
                        string
                        task id
                      

                    

                    
Example Request:

                    
curl -X 'GET' \
'http://api.scoremachine.ai/task/000xx0x0-00x0-0xxx-00x0-0xxx000xx000' \
-H 'accept: application/json' \
-H 'token: your_token'

                    
Example Response:

                    
{
"task_id": "000xx0x0-00x0-0xxx-00x0-0xxx000xx000",
"task_status": "SUCCESS",
"task_result": {
    "00000000000": {
    "valid": true,
    "normalized_phone": "00000000000",
    "tg": false
    },
    "00000000000": {
    "valid": true,
    "normalized_phone": "00000000000",
    "tg": false
    },
    "00000000000": {
    "valid": true,
    "normalized_phone": "00000000000",
    "tg": false
    }
}
}

                    
Response Fields:

                    

                      

                        Field
                        Type
                        Description
                      

                      

                        task_id
                        string
                        The task id
                      

                      

                        task_status
                        string
                        The status of the task_status. Possible values: PENDING, STARTED, SUCCESS, FAILURE, RETRY, REVOKED
                      

                      

                        task_result
                        dictionary
                        The results of the task_result in JSON format
                      

                    

                    
Possible Errors:

                    

                      

                        Error Code
                        Error
                        Description
                      

                      

                        401
                        token invalid
                        Occurs when the system token is missing or invalid
                      

                    

                  

                  

                    
user

                    
GET /user/get-balance

                    
URL: https://api.scoremachine.ai/user/get-balance

                    
HTTP Method: GET

                    
Description: This method retrieves the current balance of the authenticated user. No parameters are required, as the method provides balance information for the currently authorized user.

                    
Example Request:

                    
curl -X 'GET' \
'http://api.scoremachine.ai/user/get-balance' \
-H 'accept: application/json' \
-H 'token: your_token'

                    
Example Response:

                    
{
"balance": 100500
}

                    
Response Fields:

                    

                      

                        Field
                        Type
                        Description
                      

                      

                        balance
                        float
                        The amount of funds available in the user's account
                      

                    

                    
Possible Errors:

                    

                      

                        Error Code
                        Error
                        Description
                      

                      

                        401
                        token invalid
                        Occurs when the system token is missing or invalid
                      

                    

                  

                  

                    
GET /user/get-transactions

                    
URL: https://api.scoremachine.ai/user/get-transactions

                    
HTTP Method: GET

                    
Description: This method retrieves a list of transactions showing deductions from the balance of the authenticated user. No parameters are required, as the method provides transaction history for the currently authorized user.

                    
Example Request:

                    
curl -X 'GET' \
'http://api.scoremachine.ai/user/get-transactions' \
-H 'accept: application/json' \
-H 'token: your_token'

                    
Example Response:

                    
{
"items": [
    {
    "timestamp": "YYYY-MM-DD HH:MM:SS",
    "amount": -0.0,
    "comment": "ScoreMachine validation - batch - count of phones: 3, task id: None"
    },
    ...
    {
    "timestamp": "YYYY-MM-DD HH:MM:SS",
    "amount": -0.0,
    "comment": "ScoreMachine validation - phone: 00000000000"
    }
],
"total": 0
}

                    
Response Fields:

                    

                      

                        Field
                        Type
                        Description
                      

                      

                        items
                        array
                        A list of dictionaries containing transaction details for the authenticated user. Each item includes: timestamp (string), amount (float), comment (string)
                      

                      

                        total
                        int
                        The total number of transactions returned in the response
                      

                    

                    
Possible Errors:

                    

                      

                        Error Code
                        Error
                        Description
                      

                      

                        401
                        token invalid
                        Occurs when the system token is missing or invalid
                      

                    

                  

                  

                    
Contacts

                    
For questions about implementing or using api.scoremachine.ai feel free to reach out to us:

                    

                       Technical Support & Commercial Inquiries 
[email protected]

                    

                       Website 
https://scoremachine.ai/