GeekNumsDeveloper Docs
中文English

Developer Docs

Number screening API: upload a file, create a task, fetch results

Try it in the browser

No code required. Paste an API key and run the whole flow right here, then copy the generated sample code.

Playground

Quick start

Run your first task in five minutes

01
Create an API key in the console
Sign in, open the API Keys page and create one. The key is shown in full only once.
02
Request an upload URL and upload your file
The endpoint returns a presigned URL. Your file goes straight to object storage, never through our application servers.
03
Create a task
Submit a product ID and the file path. You are charged for the effective count.
04
Poll for status and download results
Once complete, fetch a zip, a CSV, or a plain list of numbers.

Base URL

https://api.geeknums.io

All paths include the /api prefix, and it must be included when signing.

Endpoints

GET/api/open/v1/accountAccount profile and balance
GET/api/open/v1/productsAvailable products, pricing, size limits and country requirements
GET/api/open/v1/files/upload-urlRequest a presigned file upload URL
POST/api/open/v1/tasksCreate a screening task
GET/api/open/v1/tasksList tasks
GET/api/open/v1/tasks/{id}Task detail (poll for completion)
GET/api/open/v1/tasks/{id}/resultFull result package (zip)
GET/api/open/v1/tasks/{id}/result-csvFull result CSV (stable tokens)
GET/api/open/v1/tasks/{id}/activatedActivated number list
GET/api/open/v1/tasks/{id}/invalidInvalid data list